Skip to content

Commit 5364d3f

Browse files
Merge pull request #39 from ekonstantinidis/update-readme
Update README
2 parents 36e94cd + a94bcf4 commit 5364d3f

File tree

1 file changed

+16
-26
lines changed

1 file changed

+16
-26
lines changed

README.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ You can download Gitify from the [releases](https://github.com/ekonstantinidis/g
1919

2020
### Prerequisites
2121

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

2727

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

5151

52-
### Tests (JsxHint)
52+
### Tests
53+
There are 3 types of tests: `jest`, `jscs` and `jsxhint`.
54+
To run the tests:
5355

5456
npm test
5557

5658

57-
### License
58-
59-
The MIT License (MIT)
60-
61-
Copyright (c) 2015 Emmanouil Konstantinidis
59+
### Contributing
6260

63-
Permission is hereby granted, free of charge, to any person obtaining a copy
64-
of this software and associated documentation files (the "Software"), to deal
65-
in the Software without restriction, including without limitation the rights
66-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
67-
copies of the Software, and to permit persons to whom the Software is
68-
furnished to do so, subject to the following conditions:
61+
1. Fork it!
62+
2. Create your feature branch: `git checkout -b my-new-feature`
63+
3. Commit your changes: `git commit -am 'Add some feature'`
64+
4. Push to the branch: `git push origin my-new-feature`
65+
5. Submit a pull request
66+
6. Make sure tests are passing
6967

70-
The above copyright notice and this permission notice shall be included in all
71-
copies or substantial portions of the Software.
72-
73-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
74-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
75-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
76-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
77-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
78-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
79-
SOFTWARE.
68+
### License
69+
Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.

0 commit comments

Comments
 (0)