Skip to content

docs: update readme #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 22, 2021
Merged

docs: update readme #270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# react-router-bootstrap [![Travis][build-badge]][build] [![npm][npm-badge]][npm]
Integration between [React Router] v4 and [React Bootstrap].
# react-router-bootstrap [![npm][npm-badge]][npm]
Integration between [React Router] v6 and [React Bootstrap].

## Installation

For React Router v4:
For React Router v6:
```sh
npm install -S react-router-bootstrap
```

For React Router v4 or v5 (see [rr-v4] branch):
```sh
npm install -S react-router-bootstrap@rr-v4
```

For React Router v3 or lower (see [rr-v3] branch):
```sh
npm install -S react-router-bootstrap@rr-v3
Expand All @@ -19,10 +24,6 @@ Wrap your React Bootstrap element in a `<LinkContainer>` to make it behave like

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

Please note that by default React Router will match any location that contains path specified in `to` prop.
To make `<LinkContainer>` to match the location exactly, set `exact` prop to `true` or use `<IndexLinkContainer>`
instead.

## Example

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

See [CONTRIBUTING](CONTRIBUTING.md).

[React Router]: https://github.com/reactjs/react-router
[React Router]: https://github.com/remix-run/react-router
[React Bootstrap]: https://github.com/react-bootstrap/react-bootstrap

[build-badge]: https://travis-ci.org/react-bootstrap/react-router-bootstrap.svg?branch=master
[build]: https://travis-ci.org/react-bootstrap/react-router-bootstrap

[npm-badge]: https://badge.fury.io/js/react-router-bootstrap.svg
[npm]: http://badge.fury.io/js/react-router-bootstrap

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