Skip to content

Commit 658359f

Browse files
committed
chore: add more info to README
1 parent e9ac8c3 commit 658359f

File tree

1 file changed

+34
-8
lines changed

1 file changed

+34
-8
lines changed

README.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1-
# Vuex [![Build Status](https://circleci.com/gh/vuejs/vuex/tree/dev.png?style=shield)](https://circleci.com/gh/vuejs/vuex)
1+
# Vuex
22

3-
> Centralized State Management for Vue.js.
3+
[![npm](https://img.shields.io/npm/v/vuex.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)
45

5-
<p align="center">
6-
<img width="700px" src="https://raw.githubusercontent.com/vuejs/vuex/dev/docs/.vuepress/public/vuex.png">
7-
</p>
6+
---
87

9-
- [What is Vuex?](https://vuex.vuejs.org/)
10-
- [Full Documentation](http://vuex.vuejs.org/)
8+
:fire: **HEADS UP!** You're currently looking at Vuex 3 branch. If you're looking for Vuex 4, [please check out `4.0` branch](https://github.com/vuejs/vuex/tree/4.0).
9+
10+
---
11+
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.
13+
14+
Learn more about Vuex at "[What is Vuex?](https://vuex.vuejs.org/)", or get started by looking into [full documentation](http://vuex.vuejs.org/).
15+
16+
## Documentation
17+
18+
To check out docs, visit [vuex.vuejs.org](https://vuex.vuejs.org/).
1119

1220
## Examples
1321

@@ -19,15 +27,33 @@
1927

2028
Running the examples:
2129

22-
``` bash
30+
```bash
2331
$ npm install
2432
$ npm run dev # serve examples at localhost:8080
2533
```
2634

35+
## Questions
36+
37+
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.
38+
39+
## Issues
40+
41+
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.
42+
43+
## Changelog
44+
45+
Detailed changes for each release are documented in the [release notes](https://github.com/vuejs/vuex/releases).
46+
47+
## Stay In Touch
48+
49+
For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs).
50+
2751
## Contribution
2852

2953
Please make sure to read the [Contributing Guide](https://github.com/vuejs/vuex/blob/dev/.github/contributing.md) before making a pull request.
3054

3155
## License
3256

3357
[MIT](http://opensource.org/licenses/MIT)
58+
59+
Copyright (c) 2015-present Evan You

0 commit comments

Comments
 (0)