Localisation updates from https://translatewiki.net.
[mediawiki.git] / resources / lib / vuex / README.md
bloba362363a78bad2c74add39f6e39eee53cd85bd61
1 # Vuex
3 [![npm](https://img.shields.io/npm/v/vuex/next.svg)](https://npmjs.com/package/vuex)
4 [![ci status](https://circleci.com/gh/vuejs/vuex/tree/dev.png?style=shield)](https://circleci.com/gh/vuejs/vuex)
6 ---
8 :fire: **HEADS UP!** You're currently looking at Vuex 4 branch. If you're looking for Vuex 3, [please check out `dev` branch](https://github.com/vuejs/vuex).
10 ---
12 Vuex is a state management pattern + library for Vue.js applications. It serves as a centralized store for all the components in an application, with rules ensuring that the state can only be mutated in a predictable fashion. It also integrates with Vue's official [devtools extension](https://github.com/vuejs/vue-devtools) to provide advanced features such as zero-config time-travel debugging and state snapshot export / import.
14 Learn more about Vuex at "[What is Vuex?](https://next.vuex.vuejs.org/)", or get started by looking into [full documentation](http://next.vuex.vuejs.org/).
16 ## Documentation
18 To check out docs, visit [vuex.vuejs.org](https://next.vuex.vuejs.org/).
20 ## Examples
22 You may find example applications built with Vuex under the `examples` directory.
24 Running the examples:
26 ```bash
27 $ npm install
28 $ npm run dev # serve examples at localhost:8080
29 ```
31 ## Questions
33 For questions and support please use the [Discord chat server](https://chat.vuejs.org) or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests.
35 ## Issues
37 Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vuex/blob/dev/.github/contributing.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
39 ## Changelog
41 Detailed changes for each release are documented in the [release notes](https://github.com/vuejs/vuex/releases).
43 ## Stay In Touch
45 For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs).
47 ## Contribution
49 Please make sure to read the [Contributing Guide](https://github.com/vuejs/vuex/blob/dev/.github/contributing.md) before making a pull request.
51 ## License
53 [MIT](http://opensource.org/licenses/MIT)
55 Copyright (c) 2015-present Evan You