From 2f1b32400dfaac050bcf42b05b77ba5bd67700ed Mon Sep 17 00:00:00 2001 From: Adam Setch Date: Thu, 7 May 2026 13:09:41 -0400 Subject: [PATCH 1/3] docs: git forges Signed-off-by: Adam Setch --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f6a79ae68..b64c7c7db 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![CI Workflow][ci-workflow-badge]][github-actions] [![Release Workflow][release-workflow-badge]][github-actions] [![Coverage][coverage-badge]][coverage] [![Quality Gate Status][quality-badge]][quality] [![Renovate enabled][renovate-badge]][renovate] [![Contributors][contributors-badge]][github] [![Downloads - Total][downloads-total-badge]][website] [![Downloads - Latest Release][downloads-latest-badge]][website] [![OSS License][license-badge]][license] [![Latest Release][github-release-badge]][github-releases] [![Homebrew Cask][homebrew-cask-badge]][homebrew-cask] -> GitHub Notifications on your menu bar. Available on macOS, Windows and Linux. +> Git Notifications on your menu bar. Available on macOS, Windows and Linux. ![Gitify][gitify-social] @@ -10,7 +10,7 @@ ## Features -- ๐Ÿ”” Unified notifications from GitHub Cloud & GitHub Enterprise Server +- ๐Ÿ”” Unified notifications from your favorite Git forges (GitHub Cloud, GitHub Enterprise Server & Gitea) - ๐Ÿ’ป Cross-platform: macOS, Windows, and Linux - ๐ŸŽจ Customizable settings, filters and themes - ๐Ÿ–ฅ๏ธ Tray/menu bar integration @@ -41,7 +41,7 @@ A new forge needs an [adapter](src/renderer/utils/forges/) plus a designated mai 1. **Download** Gitify for free from [gitify.io][website]. 2. **Install** and launch the app for your platform. -3. **Authenticate** with your GitHub account, Personal Access Token or OAuth client/secret and start receiving notifications. +3. **Authenticate** with one or many supported accounts and start receiving notifications. #### Homebrew From 244c61be65531c1811f0e2d803c68d9c1e522017 Mon Sep 17 00:00:00 2001 From: Adam Setch Date: Thu, 7 May 2026 15:28:50 -0400 Subject: [PATCH 2/3] docs: git forges Co-authored-by: Copilot Signed-off-by: Adam Setch --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b64c7c7db..34e4b4280 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,24 @@ Gitify uses a forge adapter pattern (see [`MAINTAINERS.md`](MAINTAINERS.md)) so | Forge | Status | Notifications | Mark read | Mark done | Unsubscribe | Enriched details | | ----------------------------------------------- | -------------- | :-----------: | :-------: | :-------: | :---------: | :--------------: | -| **GitHub** Cloud | โœ… Supported | โœ… | โœ… | โœ… | โœ… | โœ… | -| **GitHub** Enterprise Server (โ‰ฅ 3.13) | โœ… Supported | โœ… | โœ… | โœ… | โœ… | โœ… | -| **GitHub** Enterprise Cloud with Data Residency | โœ… Supported | โœ… | โœ… | โœ… | โœ… | โœ… | -| **Gitea** (incl. Forgejo, Codeberg) | โœ… Supported | โœ… | โœ… | โ€” | โ€” | โ€” | -| **GitLab** (todos) | ๐Ÿ’ญ Considering | โ€” | โ€” | โ€” | โ€” | โ€” | -| **Bitbucket** Cloud | ๐Ÿ’ญ Considering | โ€” | โ€” | โ€” | โ€” | โ€” | -| **Azure DevOps** | ๐Ÿ’ญ Considering | โ€” | โ€” | โ€” | โ€” | โ€” | -| **Gerrit** | ๐Ÿ’ญ Considering | โ€” | โ€” | โ€” | โ€” | โ€” | - -**Status legend:** โœ… Supported ยท ๐Ÿงช Experimental (rough edges expected) ยท ๐Ÿšง In progress (adapter is being worked on) ยท ๐Ÿ’ญ Considering (open to a maintainer picking it up). +| **GitHub** Cloud | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | +| **GitHub** Enterprise Server (โ‰ฅ 3.13) | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | +| **GitHub** Enterprise Cloud with Data Residency | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | +| **Gitea** (incl. Forgejo, Codeberg) | โœ… | โœ… | โœ… | โ€” | โ€” | โ€” | +| **GitLab** (todos) | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | +| **Bitbucket** Cloud | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | +| **Azure DevOps** | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | +| **Gerrit** | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | + +> [!NOTE] +> **Status legend** +> +> | Symbol | Meaning | +> | ------ | ------- | +> | โœ… | Supported | +> | ๐Ÿงช | Experimental (rough edges expected) | +> | ๐Ÿšง | In progress (adapter is being worked on) | +> | ๐Ÿ’ญ | Considering (open to a maintainer picking it up) | A new forge needs an [adapter](src/renderer/utils/forges/) plus a designated maintainer โ€” see [the contributing guide](CONTRIBUTING.md#multi-forge-support) for the full policy. From 611193c10880a48cb7694839a6acd8aa1b775dd3 Mon Sep 17 00:00:00 2001 From: Adam Setch Date: Fri, 8 May 2026 08:36:54 -0400 Subject: [PATCH 3/3] docs: git forges Co-authored-by: Copilot Signed-off-by: Adam Setch --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 34e4b4280..0ce820512 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,12 @@ ## Supported forges -Gitify uses a forge adapter pattern (see [`MAINTAINERS.md`](MAINTAINERS.md)) so notifications can come from any compatible Git forge, not just GitHub. +Gitify uses a forge adapter pattern so notifications can come from any compatible Git forge, not just GitHub. | Forge | Status | Notifications | Mark read | Mark done | Unsubscribe | Enriched details | | ----------------------------------------------- | -------------- | :-----------: | :-------: | :-------: | :---------: | :--------------: | | **GitHub** Cloud | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | +| **GitHub** Enterprise Server (< 3.13) | โœ… | โœ… | โœ… | โŒ | โœ… | โœ… | | **GitHub** Enterprise Server (โ‰ฅ 3.13) | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | | **GitHub** Enterprise Cloud with Data Residency | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | | **Gitea** (incl. Forgejo, Codeberg) | โœ… | โœ… | โœ… | โ€” | โ€” | โ€” | @@ -32,17 +33,21 @@ Gitify uses a forge adapter pattern (see [`MAINTAINERS.md`](MAINTAINERS.md)) so | **Azure DevOps** | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | | **Gerrit** | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | +
+Status legend + +| Symbol | Meaning | +| ------ | ------- | +| โœ… | Supported | +| โŒ | Unsupported | +| ๐Ÿงช | Experimental (rough edges expected) | +| ๐Ÿšง | In progress (adapter is being worked on) | +| ๐Ÿ’ญ | Considering (open to a maintainer picking it up) | + +
+ > [!NOTE] -> **Status legend** -> -> | Symbol | Meaning | -> | ------ | ------- | -> | โœ… | Supported | -> | ๐Ÿงช | Experimental (rough edges expected) | -> | ๐Ÿšง | In progress (adapter is being worked on) | -> | ๐Ÿ’ญ | Considering (open to a maintainer picking it up) | - -A new forge needs an [adapter](src/renderer/utils/forges/) plus a designated maintainer โ€” see [the contributing guide](CONTRIBUTING.md#multi-forge-support) for the full policy. +> _A new forge needs an [adapter](src/renderer/utils/forges/) plus a designated maintainer. See [our contributing guide](CONTRIBUTING.md#multi-forge-support) for the full policy._ ## Quick Start