Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
presidenten committed Apr 25, 2017
1 parent 4efadab commit be24754
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Vuex+
Opinionated library that handles instances in Vuex.
Vuex+ uses Webpack to handle some automation.

...instructions are on their way. Until then take a sneak peak at [https://github.com/presidenten/vuex-plus-demo](https://github.com/presidenten/vuex-plus-demo) to see what it is all about.
Vuex+ makes it easy to decide when to share state and when to use new instances.
```html
<counterGroup></counterGroup>
<counterGroup></counterGroup>
<counterGroup instance="foo"></counterGroup>
```
![piri](./docs/instances.gif)

Vuex+ uses Webpack to handle automation.

### Enhancements over Vuex instance handling (2.3.0)+
From Vuex 2.3.0 onward vuex supports the same notation as vue `data` property to [handle instantiation](https://vuex.vuejs.org/en/modules.html).
Expand All @@ -12,16 +18,17 @@ In most cases this will be enough, but sometimes you need something more. Here i

Enhancements:
- Instances can be shared across components
- Flag to decide if the state instance should be clared when the last instance component is destroyed
- Flag to decide if the state instance should be clared when the last top level instance component is destroyed
- Submodule instances
- Generated API for magic strings
- Naming conventions to support automatic HMR out of the box
- Automatic Vuex HMR (needs naming conventions)

Limitations:
- Instances populates the vuex store at top level
### How to use
Check out the extensive tutorial bundled with the example:
[https://github.com/presidenten/vuex-plus-demo](https://github.com/presidenten/vuex-plus-demo)

### Authors
### Contributers
- [Zyrica](https://github.com/zyrica)
- [Presidenten](https://github.com/persidenten)

# License
MIT
Binary file added docs/instances.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vuex-plus",
"version": "0.4.0",
"version": "0.4.1",
"description": "Opinionated library that handles module instances in Vuex",
"main": "dist/vuex+.js",
"scripts": {
Expand Down

0 comments on commit be24754

Please sign in to comment.