From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Fri, 22 May 2020 08:28:51 +0000 (+0200)
Subject: docs(types): add notes about breaking typis
X-Git-Tag: v4.0.0-alpha.13~56
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fd49bbd085e9df7804994ea188f94384ac22e048;p=thirdparty%2Fvuejs%2Frouter.git

docs(types): add notes about breaking typis

Close #264
---

diff --git a/README.md b/README.md
index c2528ad3..e6358d8a 100644
--- 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.