updated readme

Author: alesanchezr

README.md

@@ -1,34 +1,36 @@
-# Hello World with React and Cloud 9
+# Hello World with React boilerplate
 
-Requirements: Make sure you are using node version 8
-* `$ node -v` to check which node version you are using
-* `$ nvm use 8` to switch to using version 8
-* `$ nvm install 8` to install version 8 if necessary
+This template its similar to create-react-app but is meant for 4Geeks Academy students.
 
 ##### Download the boilerplate using the BreatheCode CLI
 ```
 $ npm i breathecode-cli -g
+$ bc start:react-project -r
 ```
 
-##### Download the boilerplate using the BreatheCode CLI
+#### Or Download the boilerplate using git
+
 ```
-$ bc start:react-project -r
+$ git clone https://github.com/4GeeksAcademy/react-hello.git
+$ cd react-hello
 ```
+
 ##### and install the npm package:
 ```
 $ npm install
 ```
 
-## Start coding! 
+## Start coding!
 
 Start the webpack server with live reload:
+- `$ npm run gitpod` for Gitpod Users.
 - `$ npm run c9` for Cloud 9 Users.
-- `$ npm run dev-server` for windows, mac or linux.
+- `$ npm run start` for windows, mac or linux.
 
 You can update the `styles/index.scss` or `js/index.js` depending on your needs.
 Add more files into your, `./src/js/components` or styles folder as you need them.
 
-## Publish your website! 
+## Publish your website!
 
 This boilerplate is 100% compatible with the free github pages hosting.
 To publish your website you need to `push your code to your github repository` and run the following command after:
@@ -39,7 +41,7 @@ $ npm run deploy
 ## Other features
 
 - Automatic Code Formatting: Use of [Prettier](https://prettier.io/) for automatic code identation and formating.
-- Error reporting: Use of [esling](https://eslint.org/) for better error reporting.
+- Error reporting: Use of [eslint](https://eslint.org/) for better error reporting.
 - Hot Deploy: Use of [Webpack Development Server](https://webpack.js.org/configuration/dev-server/) for hot deploy and live reload.
-- One-click publish of the code to github pages.
+- One-command publish of the code to github pages with `npm run deploy`.
 - Babel 7 (really fast).

deploy-to-github.js

@@ -16,7 +16,7 @@ if (!fs.existsSync(path.resolve(__dirname,'.git'))){
 const origin = remoteOriginUrl.sync();
 if(!origin || origin==''){
     Console.error("No remote origin has been found on this repository");
-    Console.help(`Check your remote by doing: 
+    Console.help(`Check your remote by doing:
 $ git remote get-url origin
 
 Add your remote by doing:
@@ -36,14 +36,15 @@ compiler.run((err, stats) => {
       Console.error("There was an error compiling, review above");
       return;
     }
-    Console.success("Your code compiled successfully, proceding to deploy...");
+    Console.info("Your code compiled successfully, proceding to deploy...");
     ghpages.publish('public', function(err) {
         if(err){
             console.error(err);
             Console.error("There was an error publishing your website");
             return;
-        } 
+        }
         //https://<github_user>.github.io/<repository-name>
         Console.success(`Your website has been deployed successfully here: https://${repository["owner"]}.github.io/${repository["name"]}/`);
+        Console.info(`Changes on your deployed website take 10 min aprox to show, please be patient. Happy coding!`);
     });
 });