Evan You 8 anos atrás
pai
commit
c4ed3a9ff0
4 arquivos alterados com 13 adições e 25 exclusões
  1. 10 22
      README.md
  2. 1 1
      docs/book.json
  3. 1 1
      docs/en/hot-reload.md
  4. 1 1
      docs/en/structure.md

+ 10 - 22
README.md

@@ -1,41 +1,29 @@
-# Vuex [![Build Status](https://img.shields.io/circleci/project/vuejs/vuex/master.svg)](https://circleci.com/gh/vuejs/vuex) [![npm package](https://img.shields.io/npm/v/vuex.svg)](https://www.npmjs.com/package/vuex)
+# Vuex [![Build Status](https://img.shields.io/circleci/project/vuejs/vuex/dev.svg)](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)

+ 1 - 1
docs/book.json

@@ -3,7 +3,7 @@
   "plugins": ["edit-link", "prism", "-highlight", "github"],
   "pluginsConfig": {
     "edit-link": {
-      "base": "https://github.com/vuejs/vuex/tree/master/docs",
+      "base": "https://github.com/vuejs/vuex/tree/dev/docs",
       "label": "Edit This Page"
     },
     "github": {

+ 1 - 1
docs/en/hot-reload.md

@@ -41,4 +41,4 @@ if (module.hot) {
 }
 ```
 
-Checkout the [counter-hot example](https://github.com/vuejs/vuex/tree/master/examples/counter-hot) to play with hot-reload.
+Checkout the [counter-hot example](https://github.com/vuejs/vuex/tree/dev/examples/counter-hot) to play with hot-reload.

+ 1 - 1
docs/en/structure.md

@@ -29,4 +29,4 @@ For any non-trivial app, we will likely need to leverage modules. Here's an exam
         └── products.js   # products module
 ```
 
-As a reference, check out the [Shopping Cart Example](https://github.com/vuejs/vuex/tree/master/examples/shopping-cart).
+As a reference, check out the [Shopping Cart Example](https://github.com/vuejs/vuex/tree/dev/examples/shopping-cart).