Skip to content

Improve README #399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 26, 2020
Merged

Improve README #399

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73dbefa
Update README.md
manosim Apr 26, 2020
7e15a6d
Improve README.md
manosim Apr 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# Gitify [![github][github-image]][github-url] [![codecov][codecov-image]][codecov-url] [![downloads][downloads-image]][downloads-url]

> The mobile app has been deprecated in favor of the official GitHub mobile app that is coming out [soon](https://github.com/mobile).
> 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).

![Gitify](assets/images/press.png)

### Download

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.

You can also install Gitify via [Homebrew Cask](http://brew.sh/)
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/).

```shell
brew cask install gitify
```

Gitify currently only supports mac OS.
Gitify supports macOS, Windows and Linux.

### Prerequisites

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

### Development

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).
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).

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

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

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

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.
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.

### Contributing

Expand Down