Skip to content

Commit

Permalink
updating readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff Gran committed Mar 9, 2016
1 parent b35b3bb commit 1b3ce01
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,23 @@ MobStore takes hierarchical JSON data and turns it back into a graph.

MobStore automatically hooks up bidirectional, potentially circular references based on the associations you define, and makes the entire graph reactive, so you can change any part of your data and see the results in your UI immediately.

MobStore is an alternative to Flux/Redux. The unidirectional data-flow is still there, but instead of having a Rube Goldberg machine of action creators and reducers in order to change your data, you can just call a method. And there's no need to flatten your data or deal with a global state tree. You can have a proper graph of data on the client.


### Current status

This is being used in production at Trelora, inc. It works great for our needs. However, we have only added the features we need as we need them, so there is definitely still missing functionality.
This is being used in production at Trelora, inc. It works great for our needs. However, we have only added the features we need as we need them, so there is probably still missing functionality.

### Missing features

* There is currently no way to remove data from a store.
* There is no easy way to inject data formatted in HAL, JSONAPI, etc. Would be nice to add a parser/adapter layer to be able to easily inject different data formats.
* There is currently no way to remove data from a store. TODO: `myStore.eject(id_or_ids)`, `myStore.clear()`
* There is no automatic way to inject data formatted in HAL, JSONAPI, etc. Would be nice to add a parser/adapter layer to be able to easily inject different data formats.
* MobStore does not do any server communication. Not sure whether it ever will, but currently getting the actual data is up to you.
* What else? File an issue.

## Docs

Documentation and examples (works in progress!) are available at http://trelora.github.io/mobstore/.
Documentation and examples (works in progress!) are available at [MobStore Documentation](http://trelora.github.io/mobstore/).


## Contributing
Expand Down
16 changes: 16 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,19 @@ MobStore takes hierarchical JSON data and turns it back into a graph.

MobStore automatically hooks up bidirectional, potentially circular references based on the associations you define, and makes the entire graph reactive, so you can change any part of your data and see the results in your UI immediately.

MobStore is an alternative to Flux/Redux. The unidirectional data-flow is still there, but instead of having a Rube Goldberg machine of action creators and reducers in order to change your data, you can just call a method. And there's no need to flatten your data or deal with a global state tree. You can have a proper graph of data on the client.

### Current status

This is being used in production at Trelora, inc. It works great for our needs. However, we have only added the features we need as we need them, so there is probably still missing functionality.

### Missing features

* There is currently no way to remove data from a store. TODO: `myStore.eject(id_or_ids)`, `myStore.clear()`
* There is no automatic way to inject data formatted in HAL, JSONAPI, etc. Would be nice to add a parser/adapter layer to be able to easily inject different data formats.
* MobStore does not do any server communication. Not sure whether it ever will, but currently getting the actual data is up to you.
* What else? File an issue.


## Hello MobStore

Expand All @@ -26,6 +39,9 @@ const itemStore = new MobStore({

itemStore.inject({id: 1, name: "item one"})

itemStore.items
// => [{id: 1, name: "item one"}]

itemStore.find(1)
// => {id: 1, name: "item one"}
```

0 comments on commit 1b3ce01

Please sign in to comment.