docs(types): add notes about breaking typis

Close #264

diff --git a/README.md b/README.md
index c2528ad3561d16cbef0fe6cace6de51457a306b0..e6358d8a81f2ddef5f2d9d60b2c34264b6c8a38e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -40,6 +40,16 @@ Check the [playground](https://github.com/vuejs/vue-router-next/tree/master/play
   })
   ```
 
+### Typings
+
+To make typings more consistent and expressive, some types have been renamed. Keep in mind these can change until stable release to ensure consistency. Some types might have changed as well.
+
+| `vue-router@3` | `vue-router@4`          |
+| -------------- | ----------------------- |
+| RouteConfig    | RouteRecordRaw          |
+| Location       | RouteLocation           |
+| Route          | RouteLocationNormalized |
+
 #### Improvements
 
 These are technically breaking changes but they fix an inconsistent behavior.