Skip to content

Commit

Permalink
Explain example docs better
Browse files Browse the repository at this point in the history
  • Loading branch information
gaearon committed Aug 14, 2015
1 parent 3c71240 commit edca0f5
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/introduction/Examples.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Examples

Redux is distributed with a few examples in its [source code](https://github.com/gaearon/redux/tree/master/examples).

**To run any of them, clone the repo and run `npm install` both in the root and the example folder.**
Redux is distributed with a few examples in its [source code](https://github.com/gaearon/redux/tree/master/examples).
**To run either of them, clone the repo and run `npm install` both in the root and the example folder.**

>##### Note on Copying
>If you copy Redux examples outside their folders, remove these lines from their `webpack.config.js`:
Expand All @@ -29,11 +28,13 @@ Run the [Counter](https://github.com/gaearon/redux/tree/master/examples/counter)

```
git clone https://github.com/gaearon/redux.git
cd redux
npm install
cd examples/counter
npm install
npm start
open http://localhost:3000/
```
Expand All @@ -49,11 +50,13 @@ Run the [TodoMVC](https://github.com/gaearon/redux/tree/master/examples/todomvc)

```
git clone https://github.com/gaearon/redux.git
cd redux
npm install
cd examples/todomvc
npm install
npm start
open http://localhost:3000/
```
Expand All @@ -70,11 +73,13 @@ Run the [Async](https://github.com/gaearon/redux/tree/master/examples/async) exa

```
git clone https://github.com/gaearon/redux.git
cd redux
npm install
cd examples/async
npm install
npm start
open http://localhost:3000/
```
Expand All @@ -90,8 +95,14 @@ It covers:
Run the [Real World](https://github.com/gaearon/redux/tree/master/examples/real-world) example:

```
git clone https://github.com/gaearon/redux.git
cd redux
npm install
cd examples/real-world
npm install
npm start
open http://localhost:3000/
```
Expand Down

0 comments on commit edca0f5

Please sign in to comment.