Merge pull request #1 from grooves/create-readme

Create README.md

README.md

@@ -0,0 +1,36 @@
+# forkwell_for_chrome
+
+Chrome extention for Forkwell Jobs. If you access a web site managed a company published Forkwell Jobs, this extention shows its job posting.
+
+## Setup
+
+### create extention
+
+you need to install `nodejs` for using `npm`.
+
+```
+$ npm install -g gulp
+$ cd ${PROJECT_ROOT}
+$ gulp
+# => create `dist` directory
+```
+
+## Install
+
+### production
+
+TODO: write chrome web store url
+
+### development
+
+Drag and drop `${PROJECT_ROOT}/dist` directroy into `chrome://extensions/` page.
+
+## Contributing
+
+If you have a problem, please create an issue or a pull request.
+
+1. Fork it
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create new Pull Request