|
@@ -1,41 +1,29 @@
|
|
|
-# Vuex [](https://circleci.com/gh/vuejs/vuex) [](https://www.npmjs.com/package/vuex)
|
|
|
+# Vuex [](https://circleci.com/gh/vuejs/vuex)
|
|
|
|
|
|
-> Flux-inspired Application Architecture for Vue.js.
|
|
|
+> Centralized State Management for Vue.js.
|
|
|
|
|
|
<p align="center">
|
|
|
<img width="700px" src="https://raw.githubusercontent.com/vuejs/vuex/master/docs/en/vuex.png">
|
|
|
</p>
|
|
|
|
|
|
-- [Documentation](http://vuejs.github.io/vuex/)
|
|
|
-- [Great introduction and explanation by @skyronic](http://skyronic.com/2016/01/03/vuex-basics-tutorial/) (using outdated 0.3.0 API, but still worth a read!)
|
|
|
-- [Vuex introduction video - James Browne from London Vue.js Meetup #1](https://www.youtube.com/watch?v=l1KHL-TX3qs)
|
|
|
+- [What is Vuex?](http://vuex.vuejs.org/en/intro.html)
|
|
|
+- [Full Documentation](http://vuex.vuejs.org/)
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
-- [Counter](https://github.com/vuejs/vuex/tree/master/examples/counter)
|
|
|
-- [Counter with Hot Reload](https://github.com/vuejs/vuex/tree/master/examples/counter-hot)
|
|
|
-- [TodoMVC](https://github.com/vuejs/vuex/tree/master/examples/todomvc)
|
|
|
-- [Flux Chat](https://github.com/vuejs/vuex/tree/master/examples/chat)
|
|
|
-- [Shopping Cart](https://github.com/vuejs/vuex/tree/master/examples/shopping-cart)
|
|
|
+- [Counter](https://github.com/vuejs/vuex/tree/dev/examples/counter)
|
|
|
+- [Counter with Hot Reload](https://github.com/vuejs/vuex/tree/dev/examples/counter-hot)
|
|
|
+- [TodoMVC](https://github.com/vuejs/vuex/tree/dev/examples/todomvc)
|
|
|
+- [Flux Chat](https://github.com/vuejs/vuex/tree/dev/examples/chat)
|
|
|
+- [Shopping Cart](https://github.com/vuejs/vuex/tree/dev/examples/shopping-cart)
|
|
|
|
|
|
Running the examples:
|
|
|
|
|
|
``` bash
|
|
|
$ npm install
|
|
|
-$ npm run counter # run the counter example
|
|
|
+$ npm run dev # serve examples at localhost:8080
|
|
|
```
|
|
|
|
|
|
-See [npm scripts](https://github.com/vuejs/vuex/blob/master/package.json#L11-L15) for all example npm scripts.
|
|
|
-
|
|
|
-## Principles
|
|
|
-
|
|
|
-- Terse
|
|
|
-- Testable
|
|
|
-- Reactive
|
|
|
-- Single State Tree
|
|
|
-- Hot Reloading
|
|
|
-- Time Travel (with [vue-devtools](https://github.com/vuejs/vue-devtools) support)
|
|
|
-
|
|
|
## License
|
|
|
|
|
|
[MIT](http://opensource.org/licenses/MIT)
|