Skip to content

Commit c7630cd

Browse files
authored
docs: update readme content (#2620)
Signed-off-by: Adam Setch <adam.setch@outlook.com>
1 parent f79ecf9 commit c7630cd

1 file changed

Lines changed: 38 additions & 6 deletions

File tree

README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,54 @@
66
77
![Gitify][gitify-social]
88

9-
### Download
9+
---
1010

11-
You can download Gitify for **free** from [gitify.io][website] or install it via [Homebrew Cask][brew].
11+
## Features
1212

13+
- 🔔 Unified notifications from GitHub Cloud & GitHub Enterprise Server
14+
- 💻 Cross-platform: macOS, Windows, and Linux
15+
- 🎨 Customizable settings, filters and themes
16+
- 🖥️ Tray/menu bar integration
17+
- ⚡ Fast, native experience
18+
19+
20+
## Quick Start
21+
22+
1. **Download** Gitify for free from [gitify.io][website].
23+
2. **Install** and launch the app for your platform.
24+
3. **Authenticate** with your GitHub account, Personal Access Token or OAuth client/secret and start receiving notifications.
25+
4.
26+
27+
#### Homebrew
28+
macOS users can also install via [Homebrew][brew]
1329
```shell
1430
brew install gitify
1531
```
1632

17-
Gitify supports macOS, Windows and Linux.
33+
34+
## Build & Development
35+
36+
To build and run Gitify locally:
37+
38+
```shell
39+
pnpm install
40+
pnpm build
41+
pnpm dev
42+
```
43+
44+
See [CONTRIBUTING.md](CONTRIBUTING.md) for full development and contribution instructions.
45+
1846

1947
### FAQ
2048

21-
Please visit our [Gitify FAQs][faqs] for all commonly asked questions.
49+
See our [Gitify FAQs][faqs] for answers to common questions.
50+
51+
52+
## Community & Support
2253

23-
### Contributing
54+
- Open an [issue][github-issues] for bugs or feature requests
55+
- See [CONTRIBUTING.md](CONTRIBUTING.md) for more ways to get involved
2456

25-
Please read our [Contributing Guidelines](CONTRIBUTING.md) for more information.
2657

2758
### License
2859

@@ -37,6 +68,7 @@ For more information, see [LICENSE](LICENSE).
3768

3869
[github]: https://github.com/gitify-app/gitify
3970
[github-actions]: https://github.com/gitify-app/gitify/actions
71+
[github-issues]: https://github.com/gitify-app/gitify/issues
4072
[github-releases]: https://github.com/gitify-app/gitify/releases/latest
4173
[github-website]: https://github.com/gitify-app/website
4274
[github-website-pulls]: https://github.com/gitify-app/website/pulls

0 commit comments

Comments
 (0)