docs: readme

diff --git a/.github/contributing.md b/.github/contributing.md
index 25a98f8c57c3e3383d5c544c6efb7562f4433149..fa4ee2573b67c858874de4b0e4bdf277f61cb98e 100644 (file)
--- a/.github/contributing.md
+++ b/.github/contributing.md
@@ -93,7 +93,7 @@ Vue Router source code can be found in the `src` directory:
 - `src/history`: history implementations that are instantianble with `create*History()`. This folder contains code related to using the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API).
 - `src/matcher`: RouteMatcher implementation. Contains the code that transforms paths like `/users/:id` into regexes and handle the transformation of locations like `{ name: 'UserDetail', params: { id: '2' } }` to strings. It contains path ranking logic and the part of dynamic routing that concerns matching urls in the right order.
 - `src/utils`: contains util functions that are used accross other sections of the router but are not contained by them.
-- `src/router`: contains the router creation, navigation execution, using the matcher, the history implementation.
+- `src/router`: contains the router creation, navigation execution, using the matcher, the history implementation. It runs navigation guards.
 - `src/index`: contains all public API as exports.
 - `src/types`: contains global types that are used across multiple sections of the router.
 

diff --git a/README.md b/README.md
index fe1875bd648335593dcaf48479c6e35cd9e9b750..16305e266ab42196ec5d0525d1d6554d016edf1b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,8 +8,15 @@ Since the library is still unstable **and because we want feedback** on bugs and
 
 ## Known issues
 
+### Breaking changes compared to vue-router@3.x
+
+- `mode: 'history'` -> `history: createWebHistory()`
+- Catch all routes (`/*`) must now be defined using a parameter with a custom regex: `/:catchAll(.*)`
+
+### Missing features
+
 - `keep-alive` is not yet supported
-- no `beforeRouteEnter`
+- Partail support of per-component navigation guards. No `beforeRouteEnter`
 
 ## Contributing