Update docs (#33)

* docs: update readme * docs: update readme * docs: update readme Co-authored-by: Justin Schrader <[email protected]>
icd2k3 · Nov 9, 2021 · bc717c0 · bc717c0
1 parent 53dacc0
commit bc717c0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -4,12 +4,11 @@
 
 <p align="center">
   <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>
-  <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>
   <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>
 </p>
 
 <p align="center">
-  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).
+  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>.
 </p>
 
 <hr/>
@@ -21,11 +20,11 @@
 <hr/>
 
 <p align="center">
-  <code>
-    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>
-  </code>
+  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.
 </p>
 
+---
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 - [Description](#description)
@@ -46,7 +45,7 @@
 
 ## Description
 
-Render breadcrumbs for `react-router` however you want!
+Render breadcrumbs for `react-router` 6 however you want!
 
 #### Features
 - Easy to get started with automatically generated breadcrumbs.
@@ -260,9 +259,7 @@ useBreadcrumbs(routes, { excludePaths: ['/', '/no-breadcrumb/for-this-route'] })
 
 ## Order matters!
 
-`use-react-router-breadcrumbs` uses the same strategy as `React Router v6` to calculate the routing order.
-
-... in certain cases. Consider the following:
+`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.
 
 ```js
 [

diff --git a/package.json b/package.json
@@ -62,6 +62,7 @@
   },
   "keywords": [
     "react",
+    "hook",
     "router",
     "breadcrumbs",
     "react-router",