ntfy/README.md
Philipp C. Heckel 3f85e0a0c8
Update README.md
2022-08-21 21:41:03 -04:00

6.4 KiB

ntfy


👶 Baby break!

(8/2022) Hey folks, my daughter is about to be born, so I'll be taking some time off from working on ntfy. I'll likely return to working on features and bugs in a few weeks. I hope you understand. I may post some pictures in #387 🥰


ntfy.sh | Send push notifications to your phone or desktop via PUT/POST

Release Go Reference Tests Go Report Card codecov Discord Matrix Matrix space Healthcheck

ntfy (pronounce: notify) is a simple HTTP-based pub-sub notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, entirely without signup or cost. It's also open source (as you can plainly see) if you want to run your own.

I run a free version of it at ntfy.sh. There's also an open source Android app (see Google Play or F-Droid), and an open source iOS app (see App Store).

Documentation

Getting started | Android/iOS | API | Install / Self-hosting | Building

Chat

You can directly contact me on Discord or on Matrix (bridged from Discord), or via the GitHub issues, or find more contact information on my website.

Announcements / beta testers

For announcements of new releases and cutting-edge beta versions, please subscribe to the ntfy.sh/announcements topic. If you'd like to test the iOS app, join TestFlight. For Android betas, join Discord/Matrix (I'll eventually make a testing channel in Google Play).

Contributing

I welcome any and all contributions. Just create a PR or an issue. To contribute code, check out the build instructions for the server and the Android app. Or, if you'd like to help translate 🇩🇪 🇺🇸 🇧🇬, you can start immediately in Hosted Weblate.

Translation status

License

Made with ❤️ by Philipp C. Heckel.
The project is dual licensed under the Apache License 2.0 and the GPLv2 License.

Third party libraries and resources: