Skip to content

Commit b660d37

Browse files
authored
Merge pull request #399 from manosim/update-readme
Improve README
2 parents 6873193 + 7e15a6d commit b660d37

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# Gitify [![github][github-image]][github-url] [![codecov][codecov-image]][codecov-url] [![downloads][downloads-image]][downloads-url]
22

3-
> The mobile app has been deprecated in favor of the official GitHub mobile app that is coming out [soon](https://github.com/mobile).
3+
> GitHub Notifications on your menu bar. Available on macOS, Windows and Linux. Gitify Mobile has been deprecated in favour of the official [GitHub mobile app](https://github.com/mobile).
44
55
![Gitify](assets/images/press.png)
66

77
### Download
88

9-
You can download Gitify for **free** from either the website [www.gitify.io](https://www.gitify.io/) or from the GitHub repository [releases](https://github.com/manosim/gitify/releases) page.
10-
11-
You can also install Gitify via [Homebrew Cask](http://brew.sh/)
9+
You can download Gitify for **free** from the website [www.gitify.io](https://www.gitify.io/) or install it via [Homebrew Cask](http://brew.sh/).
1210

1311
```shell
1412
brew cask install gitify
1513
```
1614

17-
Gitify currently only supports mac OS.
15+
Gitify supports macOS, Windows and Linux.
1816

1917
### Prerequisites
2018

@@ -31,7 +29,7 @@ Gitify currently only supports mac OS.
3129

3230
### Development
3331

34-
Optional: If you want you use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default "development" keys (use at your own discretion).
32+
Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default "development" keys (use at your own discretion).
3533

3634
OAUTH_CLIENT_ID="123" OAUTH_CLIENT_SECRET="456789" yarn build
3735

@@ -76,7 +74,7 @@ To check if Gitify is approved by your organisation you can go to https://github
7674

7775
#### Something looks wrong - How can I debug?
7876

79-
Since version `1.1.0` you can now debug Gitify by pressing `alt+cmd+I`. This will open the devtools and then you can see any logs, network requests etc.
77+
You can debug Gitify by pressing <kbd>alt</kbd> + <kbd>command</kbd> + <kbd>I</kbd>. This will open the dev tools and then you can see any logs, network requests etc.
8078

8179
### Contributing
8280

0 commit comments

Comments
 (0)