Skip to content

Commit 3fb85ae

Browse files
committed
update readme and links
1 parent f725c0f commit 3fb85ae

File tree

6 files changed

+61
-11
lines changed

6 files changed

+61
-11
lines changed

README.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,65 @@
1-
# vue-router-next [![CircleCI](https://img.shields.io/circleci/project/vuejs/vue-router/next.svg?maxAge=2592000)](https://circleci.com/gh/vuejs/vue-router/tree/next)
1+
# vue-router [![Build Status](https://img.shields.io/circleci/project/vuejs/vue-router/dev.svg)](https://circleci.com/gh/vuejs/vue-router)
22

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).
44
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
621

722
``` bash
23+
# install deps
824
npm install
925

26+
# build dist files
27+
npm run build
28+
1029
# serve examples at localhost:8080
1130
npm run dev
1231

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
1537
```
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+

docs/en/advanced/scroll-behavior.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ scrollBehavior (to, from, savedPosition) {
5858
}
5959
```
6060

61-
We can also use [route meta fields](meta.md) to implement fine-grained scroll behavior control. Check out a full example [here](https://github.com/vuejs/vue-router/blob/next/examples/scroll-behavior/app.js).
61+
We can also use [route meta fields](meta.md) to implement fine-grained scroll behavior control. Check out a full example [here](https://github.com/vuejs/vue-router/blob/dev/examples/scroll-behavior/app.js).

docs/en/advanced/transitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ watch: {
5555
}
5656
```
5757

58-
See full example [here](https://github.com/vuejs/vue-router/blob/next/examples/transitions/app.js).
58+
See full example [here](https://github.com/vuejs/vue-router/blob/dev/examples/transitions/app.js).

docs/en/essentials/dynamic-matching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ const User = {
5555

5656
### Advanced Matching Patterns
5757

58-
`vue-router` uses [path-to-regexp](https://github.com/pillarjs/path-to-regexp) as its path matching engine, so it supports many advanced matching patterns such as optional dynamic segments, zero or more / one or more requirements, and even custom regex patterns. Check out its [documentation](https://github.com/pillarjs/path-to-regexp#parameters) for these advanced patterns, and [this example](https://github.com/vuejs/vue-router/blob/next/examples/route-matching/app.js) of using them in `vue-router`.
58+
`vue-router` uses [path-to-regexp](https://github.com/pillarjs/path-to-regexp) as its path matching engine, so it supports many advanced matching patterns such as optional dynamic segments, zero or more / one or more requirements, and even custom regex patterns. Check out its [documentation](https://github.com/pillarjs/path-to-regexp#parameters) for these advanced patterns, and [this example](https://github.com/vuejs/vue-router/blob/dev/examples/route-matching/app.js) of using them in `vue-router`.
5959

6060
### Matching Priority
6161

docs/en/essentials/named-routes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ router.push({ name: 'user', params: { userId: 123 }})
2929

3030
In both cases, the router will navigate to the path `/user/123`.
3131

32-
Full example [here](https://github.com/vuejs/vue-router/blob/next/examples/named-routes/app.js).
32+
Full example [here](https://github.com/vuejs/vue-router/blob/dev/examples/named-routes/app.js).

docs/en/essentials/redirect-and-alias.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ const router = new VueRouter({
3535
})
3636
```
3737

38-
For other advanced usage, checkout the [example](https://github.com/vuejs/vue-router/blob/next/examples/redirect/app.js).
38+
For other advanced usage, checkout the [example](https://github.com/vuejs/vue-router/blob/dev/examples/redirect/app.js).
3939

4040
### Alias
4141

@@ -55,4 +55,4 @@ const router = new VueRouter({
5555

5656
An alias gives you the freedom to map a UI structure to an arbitrary URL, instead of being constrained by the configuration's nesting structure.
5757

58-
For advanced usage, checkout the [example](https://github.com/vuejs/vue-router/blob/next/examples/route-alias/app.js).
58+
For advanced usage, checkout the [example](https://github.com/vuejs/vue-router/blob/dev/examples/route-alias/app.js).

0 commit comments

Comments
 (0)