[docs] update readme

electrode-io · Jul 18, 2018 · 1639cf9 · 1639cf9
1 parent b9157d7
commit 1639cf9
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 85 deletions.
diff --git a/README.md b/README.md
@@ -17,13 +17,13 @@
 
 # Getting Started
 
--   See the [Full README.md in docs](/docs/README.md) or visit our [gitbook documents].
+- See the [Full README.md in docs](docs/README.md) or visit our [gitbook documents].
 
--   [Getting Started with Electrode]
+- [Getting Started with Electrode]
 
--   Visit our site at <http://www.electrode.io>.
+- Visit our site at <http://www.electrode.io>.
 
--   See [What is Electrode] for more details on features and technologies supported.
+- See [What is Electrode] for more details on features and technologies supported.
 
 # Documentation
 
@@ -33,13 +33,13 @@ Check [gitbook] for more info about gitbook.
 
 # Contributing
 
-Do you find Electrode useful?  Please send us your encouragement with a github star.
+Do you find Electrode useful? Please send us your encouragement with a github star.
 
-Did you find an issue?  Would you like to help with the project?  Please see the [CONTRIBUTING guide](/CONTRIBUTING.md).
+Did you find an issue? Would you like to help with the project? Please See our [contributing guide] for instructions on [submitting a PR] or [reporting an issue].
 
 # Support and Acknowledgement
 
-We'd like to thank our employer @WalmartLabs because we can work on the development of Electrode platform and associated modules as Open Sourced Software for the needs of our internal teams and projects.  We love the public community and the support we get, and we address your requests as much as we could, even on our off hours.  We are always excited to get feedbacks, bug reports, and PRs.  Even if you just show us your support and encouragement, or help us promote Electrode, and we love to make Electrode work better for everyone.  Thank you.
+We'd like to thank our employer @WalmartLabs because we can work on the development of Electrode platform and associated modules as Open Sourced Software for the needs of our internal teams and projects. We love the public community and the support we get, and we address your requests as much as we could, even on our off hours. We are always excited to get feedbacks, bug reports, and PRs. Even if you just show us your support and encouragement, or help us promote Electrode, and we love to make Electrode work better for everyone. Thank you.
 
 # License
 
@@ -48,33 +48,20 @@ Copyright (c) 2016-present, WalmartLabs
 Licensed under the [Apache License, Version 2.0].
 
 [apache license, version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
-
 [announcement blog]: https://medium.com/walmartlabs/introducing-electrode-an-open-source-release-from-walmartlabs-14b836135319#.pwbddxg1z
-
 [material-ui]: http://www.material-ui.com
-
 [lerna]: https://lernajs.io/
-
 [electrode-archetype-react-app]: packages/electrode-archetype-react-app
-
 [electrode-archetype-react-app-dev]: packages/electrode-archetype-react-app-dev
-
 [generator-electrode]: packages/generator-electrode
-
 [travis-image]: https://travis-ci.org/electrode-io/electrode.svg?branch=master
-
 [travis-url]: https://travis-ci.org/electrode-io/electrode
-
 [daviddm-image]: https://david-dm.org/electrode-io/electrode/dev-status.svg
-
 [daviddm-url]: https://david-dm.org/electrode-io/electrode?type=dev
-
 [gitbook]: https://www.gitbook.com/
-
 [gitbook documents]: https://docs.electrode.io/overview/what-is-electrode.html
-
 [what is electrode]: https://docs.electrode.io/overview/what-is-electrode.html
-
-[Getting Started with Electrode]: https://docs.electrode.io/chapter1/quick-start/start-with-app.html
-
-[hello-electrode]: ./tools/hello-electrode.png
+[getting started with electrode]: https://docs.electrode.io/chapter1/quick-start/start-with-app.html
+[hello-electrode]: docs/images/hello-electrode.png
+[submitting a pr]: https://github.com/electrode-io/electrode/pulls
+[reporting an issue]: https://github.com/electrode-io/electrode/issues
diff --git a/docs/README.md b/docs/README.md
@@ -11,36 +11,43 @@
 
 > Built at @WalmartLabs powering the <http://www.walmart.com> eCommerce site, Electrode is a platform for building small to large scale universal ReactJS/NodeJS web applications with a standardized structure, best practices, and modern technologies built in. Electrode focuses on performance, component reusability, and simple deployment to multiple cloud providers—so you can focus on what makes your app unique.
 
+**It takes 5 minutes and a single command to get your own Universal React app to customize:**
+
+![Hello from Electrode][hello-electrode]
+
 ## Getting Started
 
--   To jump right in and create an app with the Electrode App Generator, see [Getting Started With Electrode](https://docs.electrode.io/chapter1/quick-start/start-with-app.html).
+- To jump right in and create an app with the Electrode App Generator, see [Create an Electrode App](chapter1/quick-start/start-with-app.md).
 
--   For all the information you need about Electrode (and Electrode Native!), visit <http://www.electrode.io>.
+- For all the information you need about Electrode (and Electrode Native!), visit <http://www.electrode.io>.
 
--   For details about features and supported technologies, see [What is Electrode].
+- For details about features and supported technologies, see [What is Electrode].
 
 ### Contributing
 
-See our [contributing guide] for instructions on [submitting a PR] or [reporting an issue].
+Do you find Electrode useful? Please send us your encouragement with a github star.
+
+Did you find an issue? Would you like to help with the project?
+Please See our [contributing guide] for instructions on [submitting a PR] or [reporting an issue].
 
 ## Packages
 
 The [Electrode main repo] uses [Lerna] to manage multiple related packages that are part of the Electrode Core.
 
 ### App Archetype
 
-[electrode-archetype-react-app] is a pair of complementing npm modules that allows common patterns across all app projects so that each app project can standardize on common development behavior and patterns. Its essentially pattern templates for build scripts.  It also requires a companion module [electrode-archetype-react-app-dev] that's meant for your app's `devDependencies`.
+[electrode-archetype-react-app] is a pair of complementing npm modules that allows common patterns across all app projects so that each app project can standardize on common development behavior and patterns. Its essentially pattern templates for build scripts. It also requires a companion module [electrode-archetype-react-app-dev] that's meant for your app's `devDependencies`.
 
 ### Component Archetype
 
 [electrode-archetype-react-component] is a pair of complementing npm modules that makes developing reusable React components as easy as possible with all the latest tools and technologies configured for you.
 
-### Yeoman Generator
+### Electrode Ignite
 
-The Yeoman [generator-electrode] npm module allows you to quickly create a Universal React App or Component with support from the archetypes, and server in Node with Hapi or Express.
+Electrode Ignite allows you to quickly create a Universal React App or Component with support from the archetypes, and server in Node with Hapi or Express.
 
 For information on how to use the modules,
-check out [Get Started With Electrode App](https://docs.electrode.io/chapter1/quick-start/start-with-app.html).
+check out [Get Started With Electrode App](chapter1/quick-start/start-with-app.html).
 
 ## Sample Applications
 
@@ -50,24 +57,23 @@ You can find sample applications in the [`samples`](https://github.com/electrode
 
 In addition to the archetypes and the generators, Electrode includes a fleet of battle-tested enterprise modules that are designed as a framework for developing and deploying NodeJS applications to power sites like <http://www.walmart.com>:
 
--   [Electrode Confippet](https://github.com/electrode-io/electrode-confippet)
--   [Electrode Electrify](https://github.com/electrode-io/electrify)
--   [Electrode CSRF JWT](https://github.com/electrode-io/electrode-csrf-jwt)
--   [Electrode Redux Router Engine](https://github.com/electrode-io/electrode-redux-router-engine)
--   [Electrode React SSR Caching](https://github.com/electrode-io/electrode-react-ssr-caching)
--   [Above The Fold Only Server Render](https://github.com/electrode-io/above-the-fold-only-server-render)
--   [Electrode Bundle Analyzer](https://github.com/electrode-io/electrode-bundle-analyzer)
+- [Electrode Confippet](https://github.com/electrode-io/electrode-confippet)
+- [Electrode Electrify](https://github.com/electrode-io/electrify)
+- [Electrode CSRF JWT](https://github.com/electrode-io/electrode-csrf-jwt)
+- [Electrode Redux Router Engine](https://github.com/electrode-io/electrode-redux-router-engine)
+- [Electrode React SSR Caching](https://github.com/electrode-io/electrode-react-ssr-caching)
+- [Above The Fold Only Server Render](https://github.com/electrode-io/above-the-fold-only-server-render)
+- [Electrode Bundle Analyzer](https://github.com/electrode-io/electrode-bundle-analyzer)
 
 ### Boilerplate Universal React Node
 
-The  [`samples/universal-react-node`](https://github.com/electrode-io/electrode/tree/master/samples/universal-react-node) directory includes a sample Electrode app. The app was created with the Electrode generator using the Electrode App archetype modules.  We've also added other demos and features to it to serve as examples.  This app demonstrates how you can use the standalone NodeJS modules listed above.
-<!-- is there a directory titled "samples" in this location? -->
+The [`samples/universal-react-node`](https://github.com/electrode-io/electrode/tree/master/samples/universal-react-node) directory includes a sample Electrode app. The app was created with the Electrode generator using the Electrode App archetype modules. We've also added other demos and features to it to serve as examples. This app demonstrates how you can use the standalone NodeJS modules listed above.
 
 For more information, see the [README](https://github.com/electrode-io/electrode/blob/master/samples/universal-react-node/README.md) file.
 
 ### Sample Universal React Node with [material-ui]
 
-You can find a sample Electrode app that uses the [material-ui] React components located here:  [`samples/universal-material-ui`](https://github.com/electrode-io/electrode/tree/master/samples/universal-material-ui).
+You can find a sample Electrode app that uses the [material-ui] React components located here: [`samples/universal-material-ui`](https://github.com/electrode-io/electrode/tree/master/samples/universal-material-ui).
 
 For more information, see the [README](https://github.com/electrode-io/electrode/blob/master/samples/universal-material-ui/README.md) file.
 
@@ -77,11 +83,11 @@ We included additional Electrode Sample Apps in the <https://github.com/electrod
 
 ## Support and Acknowledgement
 
-We would like to thank @WalmartLabs for the opportunity to develop the Electrode platform and associated modules as open source software. We know that Electrode provides an important advancement for our internal teams and projects as well as for the open source community.  
+We would like to thank @WalmartLabs for the opportunity to develop the Electrode platform and associated modules as open source software. We know that Electrode provides an important advancement for our internal teams and projects as well as for the open source community.
 
-We value the open source community and the support we receive and we are committed to addressing all requests as soon as possible—even on our off hours.  We look forward to your feedback, bug reports, and PRs.  Even if your feedback is simply a sign of your support and encouragement, or to help us promote Electrode.
+We value the open source community and the support we receive and we are committed to addressing all requests as soon as possible—even on our off hours. We look forward to your feedback, bug reports, and PRs. Even if your feedback is simply a sign of your support and encouragement, or to help us promote Electrode.
 
-We are committed to continuing our efforts to improve open source projects and most importantly, to continue improving Electrode so that it works better for everyone.  
+We are committed to continuing our efforts to improve open source projects and most importantly, to continue improving Electrode so that it works better for everyone.
 
 Thank you!
 
@@ -92,35 +98,20 @@ Thank you!
 Licensed under the [Apache License, Version 2.0].
 
 [apache license, version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
-
 [electrode main repo]: https://github.com/electrode-io/electrode
-
 [material-ui]: http://www.material-ui.com
-
 [lerna]: https://lernajs.io/
-
 [electrode-archetype-react-app]: https://github.com/electrode-io/electrode/tree/master/packages/electrode-archetype-react-app
-
 [electrode-archetype-react-app-dev]: https://github.com/electrode-io/electrode/tree/master/packages/electrode-archetype-react-app-dev
-
 [electrode-archetype-react-component]: https://github.com/electrode-io/electrode/tree/master/packages/electrode-archetype-react-component
-
 [generator-electrode]: https://github.com/electrode-io/electrode/tree/master/packages/generator-electrode
-
 [travis-image]: https://travis-ci.org/electrode-io/electrode.svg?branch=master
-
 [travis-url]: https://travis-ci.org/electrode-io/electrode
-
 [daviddm-image]: https://david-dm.org/electrode-io/electrode/dev-status.svg
-
 [daviddm-url]: https://david-dm.org/electrode-io/electrode?type=dev
-
 [contributing guide]: https://github.com/electrode-io/electrode/blob/master/CONTRIBUTING.md
-
 [submitting a pr]: https://github.com/electrode-io/electrode/pulls
-
 [reporting an issue]: https://github.com/electrode-io/electrode/issues
-
-[what is electrode]: https://docs.electrode.io/overview/what-is-electrode.html
-
-[Getting Started With Electrode]: https://docs.electrode.io/chapter1/quick-start/start-with-app.html
+[what is electrode]: /overview/what-is-electrode.md
+[getting started with electrode]: https://docs.electrode.io/chapter1/quick-start/start-with-app.html
+[hello-electrode]: images/hello-electrode.png
diff --git a/docs/chapter1/quick-start/start-with-app.md b/docs/chapter1/quick-start/start-with-app.md
@@ -2,31 +2,26 @@
 
 ## Requirements
 
-> Before proceeding, be sure to verify the [Requirements](../../overview/requirements.md) for setting up your development environment.
+Before proceeding, be sure to verify the [Requirements](../../overview/requirements.md) for setting up your development environment.
 
-**Note: Make sure the directory you will work from does not contain any spaces in the path.**
-Bad
-```bash
-c:/work\ space/electrode >
-```
-Ok
-```bash
-c:/work_space/electrode >
-```
+> Note: Make sure the directory you will work from does not contain any spaces in the path.
+
+Bad: `c:\work space\electrode`
+Good: `c:\work_space\electrode`
 
 ## Quick Guide
 
 You can start your app using the Ignite Menu or using the Ignite Single task.
 
--   Ignite Menu
+- Ignite Menu
 
 ```bash
 $ ignite
 ```
 
 Choose the option for `Generate an Electrode application`.
 
--   Ignite Single task
+- Ignite Single task
 
 ```bash
 $ ignite generate-app
@@ -53,12 +48,12 @@ Now open [localhost:3000](http://localhost:3000/) in your browser to access the
 
 ![Hello Electrode](../../images/hello-electrode.png)
 
-Go ahead and play around with the app.  View the page source to see the Server Side Rendered HTML.  Refresh the page to see the SSR content load immediately before React starts running.
+Go ahead and play around with the app. View the page source to see the Server Side Rendered HTML. Refresh the page to see the SSR content load immediately before React starts running.
 
 ## Additional Commands
 
 To view all the development tasks available enter the following:
- `clap`.
+`clap`.
 
 To start in hot mode, enter the following command:
 
@@ -78,7 +73,7 @@ To start your app in production mode:
 $ npm run prod
 ```
 
-* * *
+---
 
 ## Project Structure
 
@@ -99,12 +94,12 @@ electrode-app
 └── xclap.js
 ```
 
--   `config` - Contains the configuration for your application.
--   `src/client` - Contains your React application.
--   `src/server` - Contains your NodeJS server application with SSR support.
--   `test` - Contains the unit test for your application.
--   `xclap.js` - Entry to the Electrode archetype tasks.
+- `config` - Contains the configuration for your application.
+- `src/client` - Contains your React application.
+- `src/server` - Contains your NodeJS server application with SSR support.
+- `test` - Contains the unit test for your application.
+- `xclap.js` - Entry to the Electrode archetype tasks.
 
-The generated application included a few demo components to show you how to use Redux, CSS Modules, and React JSX.  Feel free to play with them and remove or replace them when you are ready to add your application.
+The generated application included a few demo components to show you how to use Redux, CSS Modules, and React JSX. Feel free to play with them and remove or replace them when you are ready to add your application.
 
-To continue to build React components for your Electrode Application, see [Developing Your Electrode App.](../quick-start/further-develop-app.md)
+To continue to build React components for your Electrode Application, see [Developing Your Electrode App.](./further-develop-app.md)
diff --git a/docs/images/hello-electrode.png b/docs/images/hello-electrode.png
diff --git a/tools/hello-electrode.png b/tools/hello-electrode.png