Update readme

Foleon · Apr 3, 2022 · 2ababef · 2ababef
1 parent 2bb11aa
commit 2ababef
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,17 @@
+# Note
+This router is a quick fix to supports a "." basename. But therefor doesn't allow deepnested pathnames.
+Supported:
+```
+ - "/name"
+ - "/path?with=query"
+ - "/path?with=query#andHash"
+```
+Not supported
+```
+ - "/name/another-dir"
+ - "/trailing-slash/"
+```
+
 # Welcome to React Router &middot; [![npm package][npm-badge]][npm] [![build][build-badge]][build]
 
 [npm-badge]: https://img.shields.io/npm/v/react-router-dom.svg?style=flat-square