From 8908cbdd5d9a55aacda172a61da07bbcdabf1fe2 Mon Sep 17 00:00:00 2001
From: Hemant Pawar <hemant@hemantpawar.com>
Date: Fri, 24 Mar 2017 22:50:32 +0530
Subject: [PATCH] added proper documentation for development and usage in
 README.md

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b34f4f0..676861c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,51 @@
 # Hasjob extension
 Unofficial job search extension for [Hasjob](http://hasjob.co). Allows the user to quickly check if any job is listed on [Hasjob](http://hasjob.co) for the current website.
 
-# License
+## Getting started
+You'll find source files in `script.babel` directory. Boilerplate code is genereate using Yeoman generator-chrome-extension.
+
+### Install dependencies
+Nvigate to root folder in your terminal to install project dependencies.
+```sh
+npm install
+```
+
+### Babel
+
+This extension supports ES 2015 syntax through babel transforming. While developing, When those of source has been changed, `gulp babel` should be run before test and run a extension on Chrome.
+
+```sh
+gulp babel
+```
+
+If you would like to have a continuous transforming by babel you can use `watch` task (recommended).
+
+### Watch
+
+Watch task helps you reduce your efforts during development extensions. If the task detects your changes of source files, re-compile your sources automatically or Livereload([chromereload.js](https://github.com/HemantPawar/hasjob-extension/blob/master/app/scripts.babel/chromereload.js)) reloads your extension. If you would like to know more about Live-reload and preview of Yeoman? Please see [Getting started with Yeoman and generator-webapp](http://youtu.be/zBt2g9ekiug?t=3m51s) for your understanding.
+
+```bash
+gulp watch
+```
+
+You need to load/reload extension after starting `gulp watch` for Live-reload to work.
+
+For content scripts you need to refresh pages where it is used.
+
+### Build and Package
+
+It will build your app as a result you can have a distribution version of the app in `dist`. Run this command to build your Chrome Extension app.
+
+```bash
+gulp build
+```
+
+You can also distribute your project with compressed file using the Chrome Developer Dashboard at Chrome Web Store. This command will compress your app built by `gulp build` command.
+
+```bash
+gulp package
+```
+
+
+## License
 MIT © [Hemant Pawar](https://github.com/HemantPawar)