diff --git a/README.md b/README.md index 9984ad6..44a8d83 100644 --- a/README.md +++ b/README.md @@ -2,38 +2,40 @@ Reach is a node.js module for sending notifications focused on simplicity and extensibility. What's unique about this project? In most cases apps traditionally support a limited set of notification methods, such as email, push notifications or sms, but in some cases, users would prefer being notified in some other way, such as Slack, Whatsapp, Telegram or Discord, or even all of them. The Reach SDK lets you or your app users select and configure their own notification methods, without needing to develop or implement each service. -The project was developed to support my various node.js projects, and avoid redeveloping the same functionality in each of them. I built the module to support Changd, which is a website monitoring tool. Using the Reach SDK allows users to select a myriad of notification methods to be used, without the the underlying project having to implement, manage or maintain these options. I was inspired by Apprise (which is written in python) and used Uptime Kuma as a starting point. +The project was developed to support my various node.js projects, and avoid redeveloping the same functionality in each of them. I built the module to support Changd, which is a website monitoring tool. Using the Reach SDK allows users to select a myriad of notification methods, without the the underlying project having to implement, manage or maintain these options. I was inspired by Apprise (which is written in python) and used Uptime Kuma as a starting point. If you would like to test out the concept, check out the Reach UI. It is a basic web app that lets you configure and send test notifications for each provider using your own parameters. ## Providers -Notification providers are services which the Reach SDK can send messages to. The Reach SDK has been designed to allow developers and contributors to create or add their own custom providers. If you would like to improve, or create a provider for a service not currently offered, check out the _template in the provider's folder, and please submit a pull request. - -Below is a list of notifications that the Reach SDK currently supports. - -Alerta -AWS SES -Bark -Click Send SMS -Discord -Gitter -Google Chat -IFFFF -Line -Signal -Slack -SMTP -Mailgun -Matrix -Mattermost -Microsoft Teams -OneSignal -PagerDuty -Telegram -Webhook - +Notification providers are services which the Reach SDK can send messages to. The Reach SDK has been designed to allow developers and contributors to create or add their own custom providers. If you would like to improve, or create a provider for a service not currently offered, check out the _template in the resources folder, and please submit a pull request. + +Below is a list of notification providers the Reach SDK currently supports. + +