From fd129b2db904aa722c6be50440cfe9aeb84535fb Mon Sep 17 00:00:00 2001 From: kyletsang <6854874+kyletsang@users.noreply.github.com> Date: Sun, 21 Nov 2021 22:05:30 -0800 Subject: [PATCH] docs: update readme --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6186fa0..3d30edb 100644 --- a/README.md +++ b/README.md @@ -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 @@ -19,10 +24,6 @@ Wrap your React Bootstrap element in a `` to make it behave like `` accepts same parameters as React Router's [``] -Please note that by default React Router will match any location that contains path specified in `to` prop. -To make `` to match the location exactly, set `exact` prop to `true` or use `` -instead. - ## Example Following plain React Bootstrap component @@ -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 [``]: https://github.com/ReactTraining/react-router/blob/master/packages/react-router-dom/docs/api/NavLink.md