Skip to content

Commit f138e95

Browse files
authored
docs: update readme (#270)
1 parent ab7a570 commit f138e95

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
# react-router-bootstrap [![Travis][build-badge]][build] [![npm][npm-badge]][npm]
2-
Integration between [React Router] v4 and [React Bootstrap].
1+
# react-router-bootstrap [![npm][npm-badge]][npm]
2+
Integration between [React Router] v6 and [React Bootstrap].
33

44
## Installation
55

6-
For React Router v4:
6+
For React Router v6:
77
```sh
88
npm install -S react-router-bootstrap
99
```
1010

11+
For React Router v4 or v5 (see [rr-v4] branch):
12+
```sh
13+
npm install -S react-router-bootstrap@rr-v4
14+
```
15+
1116
For React Router v3 or lower (see [rr-v3] branch):
1217
```sh
1318
npm install -S react-router-bootstrap@rr-v3
@@ -19,10 +24,6 @@ Wrap your React Bootstrap element in a `<LinkContainer>` to make it behave like
1924

2025
`<LinkContainer>` accepts same parameters as React Router's [`<NavLink>`]
2126

22-
Please note that by default React Router will match any location that contains path specified in `to` prop.
23-
To make `<LinkContainer>` to match the location exactly, set `exact` prop to `true` or use `<IndexLinkContainer>`
24-
instead.
25-
2627
## Example
2728

2829
Following plain React Bootstrap component
@@ -41,14 +42,12 @@ import { LinkContainer } from 'react-router-bootstrap'
4142

4243
See [CONTRIBUTING](CONTRIBUTING.md).
4344

44-
[React Router]: https://github.com/reactjs/react-router
45+
[React Router]: https://github.com/remix-run/react-router
4546
[React Bootstrap]: https://github.com/react-bootstrap/react-bootstrap
4647

47-
[build-badge]: https://travis-ci.org/react-bootstrap/react-router-bootstrap.svg?branch=master
48-
[build]: https://travis-ci.org/react-bootstrap/react-router-bootstrap
49-
5048
[npm-badge]: https://badge.fury.io/js/react-router-bootstrap.svg
5149
[npm]: http://badge.fury.io/js/react-router-bootstrap
5250

5351
[rr-v3]: https://github.com/react-bootstrap/react-router-bootstrap/tree/rr-v3
52+
[rr-v4]: https://github.com/react-bootstrap/react-router-bootstrap/tree/rr-v4
5453
[`<NavLink>`]: https://github.com/ReactTraining/react-router/blob/master/packages/react-router-dom/docs/api/NavLink.md

0 commit comments

Comments
 (0)