docs: add note about encoding

diff --git a/README.md b/README.md
index 3422404f5413fc697bdfdd14fadd7eecef27f349..3d31c5b2cc31d8577248e2faaca4e96948e5d61a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -62,6 +62,10 @@
   </router-view>
   ```
   See more on the [KeepAlive](https://github.com/vuejs/vue-router-next/blob/master/e2e/keep-alive/index.ts) and the [Transition](https://github.com/vuejs/vue-router-next/blob/master/e2e/transitions/index.ts) examples.
+- Encoding is now more consistent. The initial navigation should yield the same results are in-app navigations.
+  - Values in `path`, `fullPath` are not decoded anymore. They will appear as provided by the browser (most browsers provide them encoded).
+  - `params`, `query` and `hash` are now all decoded
+  - When using `push`, `resolve` and `replace` and providing a `string` location or a `path` property in an object, **it must be encoded**. `params`, `query` and `hash` must be provided in its decoded version.
 
 ### Typings