diff --git a/README.md b/README.md index a19096b..a97f298 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,29 @@
+
Desktop Client

♾️ ntfy-electron ♾️

-
-

-A ntfy.sh desktop client built with Electron which supports Windows, Linux, and MacOSX. This client rests in your taskbar tray and allows you to receive push notifications to your desktop without requiring you to leave your browser open. +
-

+

A ntfy.sh desktop client built with Electron which supports Windows, Linux, and MacOSX. This client rests in your taskbar tray and allows you to receive push notifications to your desktop without requiring you to leave your browser open.


+

-
-
-[![Version][badge-version-gh]][link-version-gh] -[![Build Status][badge-build]][link-build] -[![Downloads][badge-downloads-gh]][link-downloads-gh] -[![Size][badge-size-gh]][badge-size-gh] -[![Last Commit][badge-commit]][badge-commit] -[![Contributors][badge-all-contributors]](#contributors-) +[![Version][github-version-img]][github-version-uri] +[![Build Status][github-build-img]][github-build-uri] +[![Downloads][github-downloads-img]][github-downloads-uri] +[![Size][github-size-img]][github-size-img] +[![Last Commit][github-commit-img]][github-commit-img] +[![Contributors][contribs-all-img]](#contributors-)
@@ -44,6 +42,7 @@ A ntfy.sh desktop client built with Electron which supports Windows, Linux, and - [Build](#build) - [Linux](#linux) - [Windows](#windows) + - [Contributors ✨](#contributors-)
@@ -191,63 +190,117 @@ sudo chmod +x build.sh ./build.sh ``` - - +
- - - - - - - +--- + +
+ +## Contributors ✨ +We are always looking for contributors. If you feel that you can provide something useful to Gistr, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources: + +- [Pull Request Procedure](.github/PULL_REQUEST_TEMPLATE.md) +- [Contributor Policy](CONTRIBUTING.md) + +
+ +Want to help but can't write code? +- Review [active questions by our community](https://github.com/xdpirate/ntfy-electron/labels/help%20wanted) and answer the ones you know. + +
+ +The following people have helped get this project going: + +
+ +
+ + +[![Contributors][contribs-all-img]](#contributors-) + + + + + + + + +
xdpirate
xdpirate

💻 📆
Aetherinox
Aetherinox

💻
+
-

+ + -[link-general-npm]: https://npmjs.com -[link-general-nodejs]: https://nodejs.org -[link-npmtrends]: http://npmtrends.com/ntfy-electron + [general-npmjs-uri]: https://npmjs.com + [general-nodejs-uri]: https://nodejs.org + [general-npmtrends-uri]: http://npmtrends.com/ntfy-electron + -[badge-version-gh]: https://img.shields.io/github/v/tag/xdpirate/ntfy-electron?logo=GitHub&label=Version&color=ba5225 -[link-version-gh]: https://github.com/xdpirate/ntfy-electron/releases + [github-version-img]: https://img.shields.io/github/v/tag/xdpirate/ntfy-electron?logo=GitHub&label=Version&color=ba5225 + [github-version-uri]: https://github.com/xdpirate/ntfy-electron/releases + -[badge-version-npm]: https://img.shields.io/npm/v/ntfy-electron?logo=npm&label=Version&color=ba5225 -[link-version-npm]: https://npmjs.com/package/ntfy-electron - -[badge-license-mit]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0 -[link-license-mit]: https://github.com/xdpirate/ntfy-electron/blob/main/LICENSE - -[badge-build]: https://img.shields.io/github/actions/workflow/status/xdpirate/ntfy-electron/release-npm.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30 -[link-build]: https://github.com/xdpirate/ntfy-electron/actions/workflows/release-npm.yml - -[badge-downloads-gh]: https://img.shields.io/github/downloads/xdpirate/ntfy-electron/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892 -[link-downloads-gh]: https://github.com/xdpirate/ntfy-electron/releases -[badge-downloads-npm]: https://img.shields.io/npm/dw/%40aetherinox%2Fmarked-alert-fa?logo=npm&&label=Downloads&color=376892 -[link-downloads-npm]: https://npmjs.com/package/ntfy-electron - -[badge-size-gh]: https://img.shields.io/github/repo-size/xdpirate/ntfy-electron?logo=github&label=Size&color=59702a -[link-size-gh]: https://github.com/xdpirate/ntfy-electron/releases -[badge-size-npm]: https://img.shields.io/npm/unpacked-size/ntfy-electron/latest?logo=npm&label=Size&color=59702a -[link-size-npm]: https://npmjs.com/package/ntfy-electron - -[badge-coverage]: https://img.shields.io/codecov/c/github/xdpirate/ntfy-electron?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e -[link-coverage]: https://codecov.io/github/xdpirate/ntfy-electron + [npm-version-img]: https://img.shields.io/npm/v/ntfy-electron?logo=npm&label=Version&color=ba5225 + [npm-version-uri]: https://npmjs.com/package/ntfy-electron + + + [pypi-version-img]: https://img.shields.io/pypi/v/ntfy-electron-plugin + [pypi-version-uri]: https://pypi.org/project/ntfy-electron-plugin/ + + + [license-mit-img]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0 + [license-mit-uri]: https://github.com/xdpirate/ntfy-electron/blob/main/LICENSE + + + [github-downloads-img]: https://img.shields.io/github/downloads/xdpirate/ntfy-electron/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892 + [github-downloads-uri]: https://github.com/xdpirate/ntfy-electron/releases + + + [npmjs-downloads-img]: https://img.shields.io/npm/dw/%40aetherinox%2Fmkdocs-link-embeds?logo=npm&&label=Downloads&color=376892 + [npmjs-downloads-uri]: https://npmjs.com/package/ntfy-electron + + + [github-size-img]: https://img.shields.io/github/repo-size/xdpirate/ntfy-electron?logo=github&label=Size&color=59702a + [github-size-uri]: https://github.com/xdpirate/ntfy-electron/releases + + + [npmjs-size-img]: https://img.shields.io/npm/unpacked-size/ntfy-electron/latest?logo=npm&label=Size&color=59702a + [npmjs-size-uri]: https://npmjs.com/package/ntfy-electron + + + [codecov-coverage-img]: https://img.shields.io/codecov/c/github/xdpirate/ntfy-electron?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e + [codecov-coverage-uri]: https://codecov.io/github/xdpirate/ntfy-electron + -[badge-all-contributors]: https://img.shields.io/github/all-contributors/xdpirate/ntfy-electron?logo=contributorcovenant&color=de1f6f&label=contributors -[link-all-contributors]: https://github.com/all-contributors/all-contributors -[badge-tests]: https://img.shields.io/github/actions/workflow/status/xdpirate/ntfy-electron/npm-tests.yml?logo=github&label=Tests&color=2c6488 -[link-tests]: https://github.com/xdpirate/ntfy-electron/actions/workflows/tests.yml -[badge-commit]: https://img.shields.io/github/last-commit/xdpirate/ntfy-electron?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131 -[link-commit]: https://github.com/xdpirate/ntfy-electron/commits/main/ + [contribs-all-img]: https://img.shields.io/github/all-contributors/xdpirate/ntfy-electron?logo=contributorcovenant&color=de1f6f&label=contributors + [contribs-all-uri]: https://github.com/all-contributors/all-contributors + + + [github-build-img]: https://img.shields.io/github/actions/workflow/status/xdpirate/ntfy-electron/npm-release.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30 + [github-build-uri]: https://github.com/xdpirate/ntfy-electron/actions/workflows/npm-release.yml + + + [github-build-pypi-img]: https://img.shields.io/github/actions/workflow/status/xdpirate/ntfy-electron/release-pypi.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30 + [github-build-pypi-uri]: https://github.com/xdpirate/ntfy-electron/actions/workflows/pypi-release.yml + + + [github-tests-img]: https://img.shields.io/github/actions/workflow/status/xdpirate/ntfy-electron/npm-tests.yml?logo=github&label=Tests&color=2c6488 + [github-tests-uri]: https://github.com/xdpirate/ntfy-electron/actions/workflows/npm-tests.yml + + + [github-commit-img]: https://img.shields.io/github/last-commit/xdpirate/ntfy-electron?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131 + [github-commit-uri]: https://github.com/xdpirate/ntfy-electron/commits/main/ + +