Merge pull request #32 from lagos-devs/enhancement/#25/update-readme

Enhancement/#25/update readme

Author: akinjide

CONTRIBUTING.md

@@ -7,7 +7,7 @@ If you find a bug or have some ideas for a feature or enhancement, please raise
 
 ## Get started!!
 
-All PRs on zhishi are based on existing issues. Go through the issues log to find those that are open and don't have the `in progress` label. Issues that have the `in progress` are already being worked on by somebody else.
+All PRs on `hiddenwisdom-react-js` are based on existing issues. Go through the issues log to find those that are open and don't have the `in progress` label. Issues that have the `in progress` are already being worked on by somebody else.
 
 ## Found an issue ticket that interests me!
 
@@ -26,7 +26,7 @@ If you're contributing for the firs time, you should fork the repository first.
 
 Navigate to the sugar repository, press Fork button, then
 
-    git clone  https://github.com/YOUR-NAME/hiddenwisdom-react-js.git
+    git clone https://github.com/YOUR-NAME/hiddenwisdom-react-js.git
     cd hiddenwisdom-react-js
     git remote add upstream https://github.com/lagos-devs/hiddenwisdom-react-js.git
     git fetch upstream

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Hidden Wisdom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,20 +1,105 @@
-[![CircleCI](https://circleci.com/gh/lagos-devs/hiddenwisdom-react-js/tree/master.svg?style=svg)](https://circleci.com/gh/lagos-devs/hiddenwisdom-react-js/tree/master)
-[![Coverage Status](https://coveralls.io/repos/github/lagos-devs/hiddenwisdom-react-js/badge.svg?branch=master)](https://coveralls.io/github/lagos-devs/hiddenwisdom-react-js?branch=master)
+<p align="center">
+  <strong style="font-size: 120px">Hidden Wisdom React</strong>
+</p>
+<p align="center">
+    <a href="https://circleci.com/gh/lagos-devs/hiddenwisdom-react-js/tree/master">
+        <img src="https://circleci.com/gh/lagos-devs/hiddenwisdom-react-js/tree/master.svg?style=svg"
+             alt="CircleCI">
+    </a>
+    <a href="http://waffle.io/lagos-devs/hiddenwisdom-api">
+        <img src="https://badge.waffle.io/lagos-devs/hiddenwisdom-react-js.svg?label=ready&title=Ready"
+             alt="build status">
+    </a>
+    <a href="https://coveralls.io/github/lagos-devs/hiddenwisdom-react-js?branch=master">
+        <img src="https://coveralls.io/repos/github/lagos-devs/hiddenwisdom-react-js/badge.svg?branch=master"
+             alt="Coverage Status">
+    </a>
+</p>
+<p align="center">
+    <a href="https://github.com/lagos-devs/hiddenwisdom-react-js/graphs/contributors">
+        <img src="https://img.shields.io/github/contributors/lagos-devs/hiddenwisdom-react-js.svg?maxAge=2592000?style=plastic"
+             alt="GitHub contributors">
+    </a>
+    <a href="https://github.com/lagos-devs/hiddenwisdom-react-js/issues?q=is%3Aissue+is%3Aclosed">
+        <img src="https://img.shields.io/github/issues-closed/lagos-devs/hiddenwisdom-react-js.svg?maxAge=2592000?style=plastic"
+             alt="GitHub closed issues">
+    </a>
+    <a href="https://github.com/lagos-devs/hiddenwisdom-react-js/issues">
+        <img src="https://img.shields.io/github/issues/lagos-devs/hiddenwisdom-react-js.svg?maxAge=2592000"
+             alt="GitHub issues">
+    </a>
+    <a href="https://github.com/lagos-devs/hiddenwisdom-react-js/pulls">
+        <img src="https://img.shields.io/github/issues-pr/lagos-devs/hiddenwisdom-react-js.svg?maxAge=2592000?style=plastic"
+             alt="GitHub pull requests">
+    </a>
+</p>
+<p align="center">
+    <a href="https://github.com/lagos-devs/hiddenwisdom-react-js/blob/develop/LICENSE">
+        <img src="https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000?style=plastic"
+             alt="license">
+    </a>
+</p>
+<p align="center"><sup><strong>Reviving our wealth cultural heritage of wisdom and proverbs</strong></sup></p>
 
 
-# Hidden Wisdom React
+## [SETUP]()
+This is the Frontend React based app for Hidden Wisdom.
 
-This is the Frontend React based app for hidden wisdom
+### Prerequisites
 
-## Setup the app
+Install [Node.js](http://nodejs.org)
+ - on OSX use [homebrew](http://brew.sh) `brew install node`
+ - on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
 
-1. Clone the app: `git clone https://github.com/lagos-devs/hiddenwisdom-react-js.git`
-2. Install dependences: `npm install`
-3. Ensure you have `babel-cli` on your system: `npm install -g babel-cli`
-4. Start the application: `npm start`
+### Clone
 
-## Contribute
+Navigate to your work directory and clone the project
+```bash
+$ git clone https://github.com/<YOUR-NAME>/hiddenwisdom-react-js.git
+$ cd hiddenwisdom-react-js
+```
 
-New and exiting contributors are welcome!
+### Install
+
+Navigate to `hiddenwisdom-react-js` directory, then run `npm install` to install Node packages, ensure you have `babel-cli` on your system
+```bash
+$ npm install -g webpack
+$ npm install -g babel-cli
+$ npm install
+```
+
+### Start the Server
+
+Run `npm start` to start `hiddenwisdom-react-js` server
+```bash
+$ npm start
+```
+
+### Lint
+
+Run code analysis using below command.
+```bash
+$ npm run lint
+$ npm run lint:watch
+```
+
+### Test
+
+Run the unit tests using below command (via mocha).
+```bash
+$ npm run test
+$ npm run test:watch
+$ npm run test:coverage
+```
+
+
+## [CONTRIBUTING](CONTRIBUTING.md)
+
+New and exciting contributors are welcome!
 
 Please read through the [CONTRIBUTING GUIDE](https://github.com/lagos-devs/hiddenwisdom-react-js/blob/develop/CONTRIBUTING.md) before picking up/raising an issue. It's quite short :)
+
+
+## [LICENSE](LICENSE)
+
+MIT License

package.json

@@ -23,7 +23,7 @@
     "build": "babel-node tools/build.js",
     "postbuild": "babel-node tools/distServer.js"
   },
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
     "babel-polyfill": "6.8.0",
     "babel-runtime": "6.6.1",