Merge pull request #106 from ekonstantinidis/update-readme

Update readme, Instructions for development

Author: ekonstantinidis

README.md

@@ -14,8 +14,10 @@
 
 ![Gitify](images/press.png)
 
+
 ### Download
-You can download Gitify from the [releases](https://github.com/ekonstantinidis/gitify/releases) page. Currently only supports OS X.
+You can download Gitify for **free** from either the website [www.gitify.io](http://www.gitify.io/) or from the GitHub repository [releases](https://github.com/ekonstantinidis/gitify/releases) page. Currently only supports OS X.
+
 
 ### Prerequisites
 
@@ -31,6 +33,12 @@ You can download Gitify from the [releases](https://github.com/ekonstantinidis/g
 
 
 ### Development
+First you will need to set the testing `client_id` and `client_secret_key` in the `src/js/components/login.js`. You can use the development app credentials(use at your own discretion):
+
+    Client Id: 3fef4433a29c6ad8f22c
+    Client Secret Key: 9670de733096c15322183ff17ed0fc8704050379
+
+
 To watch for changes in the `src` directory:
 
     npm run watch
@@ -43,13 +51,13 @@ To run the actual **electron app**:
 ### Distribution
 To prepare the app for distribution run:
 
-    npm run dist
+    npm run package
 
-Currently supports only OS X.
+To publish a new version, you also need to codesign the app running `npm run codesign`. Currently supports only OS X.
 
 
 ### Tests
-There are 3 types of tests: `jest`, `jscs` and `jsxhint`.
+There are 2 types of tests: `jest` and `eslint`.
 To run the tests:
 
     npm test
@@ -64,5 +72,6 @@ To run the tests:
 5. Submit a pull request
 6. Make sure tests are passing
 
+
 ### License
 Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.

package.json

@@ -9,7 +9,9 @@
     "watch-js": "watchify -t babelify src/js/app.js -o build/js/app.js -v",
     "watch": "npm run build && grunt build && npm run watch-js & grunt watch",
     "start": "electron .",
-    "dist": "electron-packager . Gitify --overwrite --platform=darwin --arch=x64 --version=0.32.3 --asar=true --icon=images/app-icon.icns --prune --ignore='src' --ignore='coverage' && bash scripts/codesign.bash",
+    "package": "electron-packager . Gitify --overwrite --platform=darwin --arch=x64 --version=0.32.3 --asar=true --icon=images/app-icon.icns --prune --ignore='src' --ignore='coverage'",
+    "codesign": "bash scripts/codesign.bash",
+    "dist": "npm run package && npm run codesign",
     "lint": "eslint 'src/js/' 'src/js/app.js' 'main.js'",
     "test": "npm run lint && jest"
   },