Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 1.97 KB

README.md

File metadata and controls

60 lines (35 loc) · 1.97 KB

ZNotify

English | 中文

ZNotify is a project that allows you to send notifications to yourself across multiple platforms, including the Web, Android, and Windows.

ZNotify is currently in development.

Messaging Services Supported

  • Web Push
  • Google Cloud Messaging
  • Windows Push Notification Services
  • Telegram
  • WebSocket1

Client

Basic Usage

curl -X POST -d "This is a message" https://{your-znotify-server}/{user-id}

For full documentation, see the Web API Reference.

ZNotify didn't provide a public server, but you can easily deploy your own server. See Server for more information.

SDK

ZNotify has SDKs for the following languages:

You can find generated openapi specification at swagger.json. For unsupported languages, you can use the openapi specification to generate your own SDK.

Contributing

Contributions are welcome! Please submit a pull request or open an issue.

License

Different parts of ZNotify are licensed under different licenses. See the LICENSE file in each repository for more information.

Footnotes

  1. Only use as a fallback, as it consumes additional battery and data. ↩

  2. The web push availability depends on the browser. See Can I Use for more information. ↩

  3. cli is available on most of the platforms, including Windows, Linux, and macOS. If you didn't find your platform, you can build it yourself. ↩