From edca0f561d82fedbb3884f3aff65999575bfceb0 Mon Sep 17 00:00:00 2001 From: Dan Abramov Date: Fri, 14 Aug 2015 04:31:06 +0300 Subject: [PATCH] Explain example docs better --- docs/introduction/Examples.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/introduction/Examples.md b/docs/introduction/Examples.md index 974045f699..ed573f394b 100644 --- a/docs/introduction/Examples.md +++ b/docs/introduction/Examples.md @@ -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`: @@ -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/ ``` @@ -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/ ``` @@ -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/ ``` @@ -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/ ```