Skip to content

Commit bc717c0

Browse files
icd2k3jschrader-nr
andauthored
Update docs (#33)
* docs: update readme * docs: update readme * docs: update readme Co-authored-by: Justin Schrader <[email protected]>
1 parent 53dacc0 commit bc717c0

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@
44

55
<p align="center">
66
<a href="https://github.com/icd2k3/use-react-router-breadcrumbs/actions" target="_blank"><img src="https://github.com/icd2k3/use-react-router-breadcrumbs/workflows/Node.js%20CI/badge.svg" /></a>
7-
<a href="https://david-dm.org/icd2k3/use-react-router-breadcrumbs" title="dependencies status"><img src="https://david-dm.org/icd2k3/use-react-router-breadcrumbs/status.svg"/></a>
87
<a href='https://coveralls.io/github/icd2k3/use-react-router-breadcrumbs?branch=master'><img src='https://coveralls.io/repos/github/icd2k3/use-react-router-breadcrumbs/badge.svg?branch=master' alt='Coverage Status' /></a>
98
</p>
109

1110
<p align="center">
12-
A small (~1.25kb gzip), flexible, <a href="https://reactjs.org/docs/hooks-intro.html">hook</a> for rendering breadcrumbs with <a href="https://github.com/ReactTraining/react-router">react-router</a> (5.1 and up).
11+
A small (~1.25kb gzip), flexible, <a href="https://reactjs.org/docs/hooks-intro.html">hook</a> for rendering breadcrumbs with <a href="https://github.com/ReactTraining/react-router">react-router 6</a>.
1312
</p>
1413

1514
<hr/>
@@ -21,11 +20,11 @@
2120
<hr/>
2221

2322
<p align="center">
24-
<code>
25-
If you'd rather use a Higher Order Component, check out <a href="https://github.com/icd2k3/react-router-breadcrumbs-hoc">react-router-breadcrumbs-hoc</a>
26-
</code>
23+
Using an <b>older version</B> of <code>react-router</code>? Check out <a href="https://github.com/icd2k3/react-router-breadcrumbs-hoc">react-router-breadcrumbs-hoc</a> which is compatible with v4 and v5.
2724
</p>
2825

26+
---
27+
2928
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
3029
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3130
- [Description](#description)
@@ -46,7 +45,7 @@
4645

4746
## Description
4847

49-
Render breadcrumbs for `react-router` however you want!
48+
Render breadcrumbs for `react-router` 6 however you want!
5049

5150
#### Features
5251
- Easy to get started with automatically generated breadcrumbs.
@@ -260,9 +259,7 @@ useBreadcrumbs(routes, { excludePaths: ['/', '/no-breadcrumb/for-this-route'] })
260259

261260
## Order matters!
262261

263-
`use-react-router-breadcrumbs` uses the same strategy as `React Router v6` to calculate the routing order.
264-
265-
... in certain cases. Consider the following:
262+
`use-react-router-breadcrumbs` uses the [same strategy](https://reactrouter.com/docs/en/v6/getting-started/concepts#ranking-routes) as `react-router 6` to calculate the routing order.
266263

267264
```js
268265
[

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
},
6363
"keywords": [
6464
"react",
65+
"hook",
6566
"router",
6667
"breadcrumbs",
6768
"react-router",

0 commit comments

Comments
 (0)