Merge pull request autodatadirect#44 from mrprim/storybook-readme-doc

Demo Documentation added to Readme
zeriley · Aug 3, 2018 · a9fcc5f · a9fcc5f
2 parents a949555 + 17d3abf
commit a9fcc5f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# redux-manifest
-A paginated table implementation using Redux and React 
+# Redux Manifest
+A paginated table implementation using Redux and React
+
+## Demos
+### Basic Redux Manifest Example App Demo
+
+To run the **Basic Redux Manifest Example**, run the following command in the terminal:
+```bash
+npm run example
+```
+This will serve the application on `localhost:8081`.  Navigate to that page in your browser to see the Basic Redux Manifest Example.
+
+![Alt text](/docs/basic-redux-manifest-example.png?raw=true "Optional Title")
+
+### Storybook
+
+To run [Storybook](https://github.com/storybooks/storybook) to test and debug individual React Components, run the following command in the terminal:
+```bash
+npm run demo
+```
+This will serve **Redux-Manifest** Storybook on `localhost:9001`.  Navigate to that page in your browser to see Storybook.
+
+![Alt text](/docs/redux-manifest-storybook.png?raw=true "Optional Title")
diff --git a/docs/basic-redux-manifest-example.png b/docs/basic-redux-manifest-example.png
diff --git a/docs/redux-manifest-storybook.png b/docs/redux-manifest-storybook.png