Skip to content

Commit

Permalink
Merge pull request #39 from ekonstantinidis/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
ekonstantinidis committed May 31, 2015
2 parents 36e94cd + a94bcf4 commit 5364d3f
Showing 1 changed file with 16 additions and 26 deletions.
42 changes: 16 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ You can download Gitify from the [releases](https://github.com/ekonstantinidis/g

### Prerequisites

- Electron [+](http://electron.atom.io/)
- React [+](https://facebook.github.io/react/)
- Grunt [+](http://gruntjs.com/)
- NPM [+](https://www.npmjs.com/)
- [Electron](http://electron.atom.io/)
- [React](https://facebook.github.io/react/)
- [Grunt](http://gruntjs.com/)
- [NPM](https://www.npmjs.com/)


### Installation
Expand All @@ -49,31 +49,21 @@ To prepare the app for distribution run:
Currently supports only OS X.


### Tests (JsxHint)
### Tests
There are 3 types of tests: `jest`, `jscs` and `jsxhint`.
To run the tests:

npm test


### License

The MIT License (MIT)

Copyright (c) 2015 Emmanouil Konstantinidis
### Contributing

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:
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
6. Make sure tests are passing

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.
### License
Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.

0 comments on commit 5364d3f

Please sign in to comment.