Skip to content
This repository was archived by the owner on Oct 17, 2020. It is now read-only.

Commit ff11f1d

Browse files
committed
doc tweaks
1 parent 887f50c commit ff11f1d

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

readme.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#vuex-router
1+
# vuex-router
22

33
## What is this?
44

@@ -19,8 +19,7 @@ into the store, where it can be managed and safely shared across components.
1919

2020
This is convenient from an API perspective, and allows for some very clean code. The location state is read and updated just like the rest of the application state, instead of requiring a separate routing API.
2121

22-
## How is this different than [vue-router](https://router.vuejs.org/en/) with
23-
[vuex-router-sync](https://github.com/vuejs/vuex-router-sync)?
22+
## How is this different than [vue-router](https://router.vuejs.org/en/) with [vuex-router-sync](https://github.com/vuejs/vuex-router-sync)?
2423

2524
Even when used with `vuex-router-sync`, `vue-router` still uses the browser history as the "source of truth" for the location state.
2625

@@ -45,9 +44,9 @@ Install `vuex-router` with yarn or npm.
4544

4645
The easiest way to configure `vuex-router` is with [WebPack](https://webpack.js.org/) and [babel-loader](https://github.com/babel/babel-loader). In most situations, babel-loader will find the `.babelrc` file in the `vuex-router` folder and use it to build `vuex-router`.
4746

48-
If you have questions about a specific configuration scenario, feel free to open an issue, or submit a PR with an example, even if it's only partly working.
47+
If there are questions about a specific configuration scenario, feel free to open an issue, or submit a PR with an example, even if it's only partly working.
4948

50-
A pre-transpiled version of `vuex-router` is included at `dist/vuex-router-min.js` in the npm package, but it has not been thoroughly tested. Please open an issue if you run into any problems using it.
49+
A pre-transpiled version of `vuex-router` is included at `dist/vuex-router-min.js` in the npm package, but it has not been thoroughly tested. Please open an issue if there are any problems using it.
5150

5251
### Configuring the Vuex store
5352

@@ -229,7 +228,7 @@ store.dispatch("router/goBack")
229228

230229
The user's location will be `"/"`, because when we added `"/blog"`, it _replaced_ `"/home"` in the browser's history.
231230

232-
You can learn more about browser history at [MDN - Adding and modifying history entries]([`window.history.pushState`](https://developer.mozilla.org/en-US/docs/Web/API/History_API#Adding_and_modifying_history_entries)
231+
Learn more about browser history at [MDN - Adding and modifying history entries]([`window.history.pushState`](https://developer.mozilla.org/en-US/docs/Web/API/History_API#Adding_and_modifying_history_entries)
233232

234233
#### `router/transitionEnd`
235234

0 commit comments

Comments
 (0)