Skip to content

Commit

Permalink
README updates for repo and example
Browse files Browse the repository at this point in the history
  • Loading branch information
fisherwebdev committed Jul 25, 2014
1 parent 3c2df74 commit 6b843f7
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ An application architecture for React utilizing a unidirectional data flow.

## Examples
Basic example: [TodoMVC](https://github.com/facebook/react/tree/master/examples/todomvc-flux)

Slightly more complex example: [Chat Client](https://github.com/facebook/flux/tree/master/examples/flux-chat)

## Requirements
Expand All @@ -13,11 +14,7 @@ Clone the repo and from within the `flux` directory, run the following on the co

`npm install`

Afterward, run:

`make`

This will produce the file Flux.js, which you can use within a browser.
This will run `make` automatically and produce the file Flux.js, which you can use within a browser.
The dispatcher will be available as Flux.Dispatcher.


Expand Down
41 changes: 41 additions & 0 deletions examples/flux-chat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## Flux Chat Example

This is an example application we've created to show an example of how a Flux
app is structured, and how you might use waitFor to make sure the Stores'
registered callbacks are called in the correct order.

## Running

You must have [npm](https://www.npmjs.org/) installed on your computer.
From the root project directory run these commands from the command line:

`npm install`

This will install all dependencies.

To build the project, first run this command:

`npm start`

This will perform an initial build and start a watcher process that will
update build.js with any changes you wish to make. This watcher is
based on [Browserify](http://browserify.org/) and
[Watchify](https://github.com/substack/watchify), and it transforms
React's JSX syntax into standard JavaScript with
[Reactify](https://github.com/andreypopp/reactify).

## License

> Copyright 2013-2014 Facebook, Inc.
>
> Licensed under the Apache License, Version 2.0 (the "License");
> you may not use this file except in compliance with the License.
> You may obtain a copy of the License at
>
> http://www.apache.org/licenses/LICENSE-2.0
>
> Unless required by applicable law or agreed to in writing, software
> distributed under the License is distributed on an "AS IS" BASIS,
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> See the License for the specific language governing permissions and
> limitations under the License.

0 comments on commit 6b843f7

Please sign in to comment.