Skip to content

Commit 9fc0ee9

Browse files
committed
update readme
1 parent 89da4a8 commit 9fc0ee9

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,38 @@
1-
# vue-router
2-
3-
[![Build Status](https://img.shields.io/circleci/project/vuejs/vue-router/master.svg)](https://circleci.com/gh/vuejs/vue-router)
1+
# vue-router [![Build Status](https://img.shields.io/circleci/project/vuejs/vue-router/master.svg)](https://circleci.com/gh/vuejs/vue-router)
42

53
**Compatibility Note:** `vue-router` requires Vue.js 0.12.10+
64

7-
### Usage
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:
88

9-
Docs incoming. For now please refer to the `/example` folder.
9+
- Nested route/view mapping
10+
- Modular, component-based router configuaration
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+
- Restore scroll position when going back in history mode
1017

11-
### Build
18+
Get started with the [documentation](http://vuejs.github.io/vue-router).
19+
20+
### Development Setup
1221

1322
``` bash
23+
# install deps
1424
npm install
25+
26+
# build dist files
1527
npm run build
16-
```
1728

18-
If you want to contribute, help write the tests!
29+
# serve example app at localhost:8080
30+
# and unit tests at localhost:8081
31+
npm run dev
32+
33+
# lint & run unit tests with coverage report
34+
npm test
35+
36+
# run e2e tests for example app in Chrome & Firefox
37+
npm run e2e-local
38+
```

0 commit comments

Comments
 (0)