diff --git a/README.md b/README.md index cd6de4e..0831e68 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ +
+ # ๐Ÿงฉ Gitify Organization +**Shared configuration & community health files** for the [Gitify][gitify-website] organization. + [![Renovate enabled][renovate-badge]][renovate] [![Renovate config validation][validator-badge]][validator-actions] [![Conventional Commits][commits-badge]][commits] [![License][license-badge]][license] -> Shared configuration and community health files for the [Gitify][gitify-website] organization. -> See the [organization profile](profile/README.md). +
---- +> [!NOTE] +> Public repository. It hosts our shared Renovate preset and renders the [organization profile](profile/README.md). See the [organization][gitify-org] for all projects. ## ๐Ÿ“ฆ Shared Renovate configuration @@ -44,8 +48,17 @@ A repository inherits the baseline by extending the shared preset, then adds its Released under the [MIT License](LICENSE). +--- + +
+ +Maintained by Gitify Core ยท gitify.io + +
+ [gitify-website]: https://gitify.io +[gitify-org]: https://github.com/gitify-app [renovate]: https://renovatebot.com/ [renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovate&logoColor=white [validator-actions]: https://github.com/gitify-app/.github/actions/workflows/renovate-config-validator.yml diff --git a/profile/README.md b/profile/README.md index 448423b..2edfff3 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,10 +1,82 @@ -## Welcome to Gitify +
+ +# ๐Ÿ™ Gitify + +**Git notifications in your menu bar** โ€” free & open source for macOS ยท Windows ยท Linux. ![Gitify][gitify-press] -Gitify is a free and open source desktop application that brings Git notifications to your menu bar. +[![Organization][org-badge]][gitify-org] [![Website][website-badge]][website] [![Stars][gitify-stars-badge]][gitify-repo] + +
+ +--- + +## ๐Ÿ“ฆ Products + +| Product | What it's for | Badges | +| ------- | ------------- | ------ | +| [๐Ÿ™ Gitify][gitify-repo] | Git notifications in your menu bar (macOS ยท Windows ยท Linux) | [![release][gitify-release-badge]][gitify-releases] [![downloads][gitify-downloads-badge]][gitify-releases] [![license][gitify-license-badge]][gitify-license] | +| [๐ŸชŸ electron-menubar][emenubar-repo] | Build Electron menu bar apps | [![npm][emenubar-npm-badge]][emenubar-npm] [![docs][emenubar-docs-badge]][emenubar-docs] [![license][emenubar-license-badge]][emenubar-license] | +| [๐ŸŒ website][website-repo] | Source of [gitify.io][website] | [![Astro][website-astro-badge]][website-repo] [![license][website-license-badge]][website-license] | +| [๐Ÿง gnome][gnome-repo] | Tray-icon window anchoring on GNOME | [![GNOME][gnome-badge]][gnome-repo] [![license][gnome-license-badge]][gnome-license] | +| [๐Ÿง kde][kde-repo] | Tray-icon window anchoring on KDE Plasma | [![KDE][kde-badge]][kde-repo] [![license][kde-license-badge]][kde-license] | + +## ๐Ÿค Get involved + +- โญ **Star & watch** [Gitify][gitify-repo] to follow new releases. +- ๐Ÿ› **Report a bug** or **request a feature** via [issues][gitify-issues]. +- ๐Ÿง‘๐Ÿ’ป **Contribute** โ€” see the [contributing guide][gitify-contributing]. +- ๐ŸŒ **Learn more** โ€” downloads, docs & release notes at [gitify.io][website]. + +> [!TIP] +> New contributor? Look for the [`good first issue`][gitify-good-first-issues] label to find a great starting point. -Available on macOS, Windows & Linux. +--- + +
+ +Maintained by Gitify Core ยท gitify.io + +
-[gitify-press]: https://raw.githubusercontent.com/gitify-app/website/master/public/images/social.png +[gitify-press]: https://raw.githubusercontent.com/gitify-app/website/main/public/images/social.png +[gitify-org]: https://github.com/gitify-app +[org-badge]: https://img.shields.io/badge/GitHub-gitify--app-181717?logo=github&logoColor=white +[website]: https://gitify.io +[website-badge]: https://img.shields.io/badge/website-gitify.io-1f6feb?logo=astro&logoColor=white + +[gitify-repo]: https://github.com/gitify-app/gitify +[gitify-releases]: https://github.com/gitify-app/gitify/releases/latest +[gitify-license]: https://github.com/gitify-app/gitify/blob/main/LICENSE +[gitify-issues]: https://github.com/gitify-app/gitify/issues +[gitify-contributing]: https://github.com/gitify-app/gitify/blob/main/CONTRIBUTING.md +[gitify-good-first-issues]: https://github.com/gitify-app/gitify/labels/good%20first%20issue +[gitify-release-badge]: https://img.shields.io/github/v/release/gitify-app/gitify?label=release&logo=github +[gitify-downloads-badge]: https://img.shields.io/github/downloads/gitify-app/gitify/total?label=downloads&logo=github +[gitify-license-badge]: https://img.shields.io/github/license/gitify-app/gitify?label=license&logo=github +[gitify-stars-badge]: https://img.shields.io/github/stars/gitify-app/gitify?label=stars&logo=github + +[emenubar-repo]: https://github.com/gitify-app/electron-menubar +[emenubar-npm]: https://www.npmjs.com/package/electron-menubar +[emenubar-docs]: https://electron-menubar.gitify.io/ +[emenubar-license]: https://github.com/gitify-app/electron-menubar/blob/main/LICENSE +[emenubar-npm-badge]: https://img.shields.io/npm/v/electron-menubar?logo=npm&label=npm +[emenubar-docs-badge]: https://img.shields.io/badge/docs-electron--menubar.gitify.io-1f6feb?logo=readthedocs&logoColor=white +[emenubar-license-badge]: https://img.shields.io/github/license/gitify-app/electron-menubar?label=license + +[website-repo]: https://github.com/gitify-app/website +[website-license]: https://github.com/gitify-app/website/blob/main/LICENSE +[website-astro-badge]: https://img.shields.io/badge/built%20with-Astro-ff5d01?logo=astro&logoColor=white +[website-license-badge]: https://img.shields.io/github/license/gitify-app/website?label=license + +[gnome-repo]: https://github.com/gitify-app/gnome +[gnome-badge]: https://img.shields.io/badge/GNOME%20Shell-extension-4a86cf?logo=gnome&logoColor=white +[gnome-license]: https://github.com/gitify-app/gnome/blob/main/LICENSE +[gnome-license-badge]: https://img.shields.io/github/license/gitify-app/gnome?label=license + +[kde-repo]: https://github.com/gitify-app/kde +[kde-badge]: https://img.shields.io/badge/KDE%20Plasma-KWin%20script-1d99f3?logo=kde&logoColor=white +[kde-license]: https://github.com/gitify-app/kde/blob/main/LICENSE +[kde-license-badge]: https://img.shields.io/github/license/gitify-app/kde?label=license