readme

Author: yyx990803

README.md

@@ -1,14 +1,12 @@
-# Work in Progress - Use at your own risk!
+# vue-router
 
 [![Build Status](https://img.shields.io/circleci/project/vuejs/vue-router/master.svg)](https://circleci.com/gh/vuejs/vue-router)
 
-### Notes
+**Compatibility Note:** `vue-router` requires Vue.js 0.12.10+
 
-1. This project is in active development. No guarantee of API stability until an offical release is out. Don't use in production. If you are adventurous enough to try it out, be prepared for undocumented breaking changes. If something goes wrong, consult the `example` folder which will always contain a working demo using the latest API.
+### Usage
 
-2. `vue-router` is developed against the `dev` branch of Vue core. The official release will only be compatible with Vue 0.12.10+.
-
-3. Files in `/dist` are not guaranteed to be up-to-date with src. If you are not using Browserify or Webpack you will have to build the standalone file yourself until an official release is out.
+Docs incoming. For now please refer to the `/example` folder.
 
 ### Build