Modify documentation

Author: tngan

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tony Ngan
+
+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

@@ -2,27 +2,43 @@
 
 A boilerplate for a Redux-React application using LoopBack
 
-Get Started
----
-
-Clone repo
+##Get Started
+- **Clone this repository or use npm**
 ```bash
 $ git clone https://github.com/tngan/loopback-redux-react-boilerplate.git
 ```
+```bash
+$ npm install loopback-redux-react-boilerplate
+```
 
-Install dependencies specified in package.json
+- **Install dependencies specified in package.json**
 ```bash
 $ npm install
 ```
 
-Start the server
+- **Start the server (default port is set to 3000)**
 ```bash
 $ npm start
 ```
 
-Access `localhost:3000`
+##Scripts
+- **npm run deploy**: Bundles the application into .build/dist.
+
+- **npm run start_prod**: Starts production server, make sure you have already deployed the application.
+
+- **npm run clean**: Removes the bundled files.
+
+##Built-in example
+A simple 'Hello World'-type Redux-React application is included in this boilerplate. You can find those files under /client.
+
+Hot reloading is only applied in development mode. When you simply modify and save the files (e.g. stylesheet and component.js), then you can see the change in real-time.
+
+In production mode, the code base is pre-compiled and placed under `.build/dist`.
+
+##License
+
+[MIT](LICENSE)
 
-Examples
----
+## Copyright
 
-Coming soon ...
+Copyright (C) 2015 Tony Ngan, released under the MIT License.

package.json

@@ -8,6 +8,14 @@
     "deploy": "NODE_ENV=production webpack -p --config webpack.config.production.js --progress",
     "clean": "rm -rf .build/dist"
   },
+  "keywords": [
+    "react",
+    "redux",
+    "boilerplate",
+    "loopback",
+    "webpack",
+    "react-transform"
+  ],
   "dependencies": {
     "compression": "^1.0.3",
     "cors": "^2.5.2",