Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Victor Doss
committed
Jun 24, 2015
1 parent
d56e1fb
commit 7ee21ae
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,21 @@ | ||
# flux-backbone | ||
Thin wrapper around Backbone Model and Collections to use in Flux pattern. | ||
|
||
## Documentation | ||
Please read the blog post on FluxBackbone: ["Building Backbone apps using Flux"](https://medium.com/@victordoss/building-backbone-apps-using-flux-f656fd8a873a). | ||
|
||
## Building FluxBackbone from a Cloned Repo | ||
Clone the repo and navigate into the resulting `flux-backbone` directory. Then run `npm install`. | ||
|
||
This will run [Gulp](http://gulpjs.com/)-based build tasks automatically and produce the file FluxBackbone.js, which you can then require as a module. | ||
|
||
You could then require the Dispatcher like so: | ||
|
||
```javascript | ||
var FluxBackbone = require('path/to/this/directory/FluxBackbone'); | ||
``` | ||
|
||
The build process also produces de-sugared version of FluxBackbone in a `lib` directory, and you can require those modules directly, copying them into whatever directory is most convenient for you. | ||
|
||
## Examples | ||
Todo Example: [TodoMVC](https://github.com/vidoss/flux-backbone/tree/master/examples/todos) |