|
1 |
| -# vue-router-next [](https://circleci.com/gh/vuejs/vue-router/tree/next) |
| 1 | +# vue-router [](https://circleci.com/gh/vuejs/vue-router) |
2 | 2 |
|
3 |
| -`vue-router` for Vue 2.0. |
| 3 | +> This is vue-router 2.0 which works only with Vue 2.0. For the 1.x router see the [1.0 branch](https://github.com/vuejs/vue-router/tree/1.0). |
4 | 4 |
|
5 |
| -This is still work in progress. There are numerous breaking changes from 0.7.x and docs are lacking - the best way to get started is checking out the examples. |
| 5 | +### Introduction |
| 6 | + |
| 7 | +`vue-router` is the official router for [Vue.js](http://vuejs.org). It deeply integrates with Vue.js core to make building Single Page Applications with Vue.js a breeze. Features include: |
| 8 | + |
| 9 | +- Nested route/view mapping |
| 10 | +- Modular, component-based router configuration |
| 11 | +- Route params, query, wildcards |
| 12 | +- View transition effects powered by Vue.js' transition system |
| 13 | +- Fine-grained navigation control |
| 14 | +- Links with automatic active CSS classes |
| 15 | +- HTML5 history mode or hash mode, with auto-fallback in IE9 |
| 16 | +- Customizable Scroll Behavior |
| 17 | + |
| 18 | +Get started with the [documentation](http://vuejs.github.io/vue-router), or play with the [examples](https://github.com/vuejs/vue-router/tree/dev/examples) (see how to run them below). |
| 19 | + |
| 20 | +### Development Setup |
6 | 21 |
|
7 | 22 | ``` bash
|
| 23 | +# install deps |
8 | 24 | npm install
|
9 | 25 |
|
| 26 | +# build dist files |
| 27 | +npm run build |
| 28 | + |
10 | 29 | # serve examples at localhost:8080
|
11 | 30 | npm run dev
|
12 | 31 |
|
13 |
| -# build dist files |
14 |
| -npm run build |
| 32 | +# lint & run all tests |
| 33 | +npm test |
| 34 | + |
| 35 | +# serve docs at localhost:4000 (requires global gitbook-cli) |
| 36 | +npm run docs |
15 | 37 | ```
|
| 38 | + |
| 39 | +## Questions |
| 40 | + |
| 41 | +For questions and support please use the [Gitter chat room](https://gitter.im/vuejs/vue) or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests. |
| 42 | + |
| 43 | +## Issues |
| 44 | + |
| 45 | +Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately. |
| 46 | + |
| 47 | +## Contribution |
| 48 | + |
| 49 | +Please make sure to read the [Contributing Guide](https://github.com/vuejs/vue/blob/dev/CONTRIBUTING.md) before making a pull request. |
| 50 | + |
| 51 | +## Changelog |
| 52 | + |
| 53 | +Details changes for each release are documented in the [release notes](https://github.com/vuejs/vue-router/releases). |
| 54 | + |
| 55 | +## Stay In Touch |
| 56 | + |
| 57 | +- For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs) |
| 58 | + |
| 59 | +## License |
| 60 | + |
| 61 | +[MIT](http://opensource.org/licenses/MIT) |
| 62 | + |
| 63 | +Copyright (c) 2013-2016 Evan You |
| 64 | + |
| 65 | + |
0 commit comments