diff --git a/README.md b/README.md index 6b53d84..99fa67a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # SMS Alert Channel Notifications for Grafana -## Getting Started +## Requirements + +- Docker, Docker Compose or Node v18 for host installation. +- Twilio account. -1. Create `.env` file based on `.env.example` -2. Install Docker +## Getting Started -## Run +1. Create `.env` file based on `.env.example`. +2. Start a container or run as a standalone. +3. Create a Contact Point in Grafana Alerting. -Run the command `npm run start` to start the server. +![Contact Point](https://github.com/VolkovLabs/grafana-sms-webhook/raw/main/img/contact.png) ## Docker Compose @@ -23,6 +27,10 @@ services: - 8080:3000 ``` +## Run as standalone + +Run the command `npm install` and `npm run start` to start the server. + ## REST API ``` @@ -36,3 +44,16 @@ fetch('http://localhost:3000/sendsms?number=1234567890', { }) }) ``` + +## Feedback + +We're looking forward to hearing from you. You can use different ways to get in touch with us. + +- Ask a question, request a new feature, and file a bug with [GitHub issues](https://github.com/volkovlabs/grafana-sms-webhook/issues/new/choose). +- Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and add a comment. +- Sponsor our open-source plugins for Grafana at [GitHub Sponsor](https://github.com/sponsors/VolkovLabs). +- Support our project by starring the repository. + +## License + +Apache License Version 2.0, see [LICENSE](https://github.com/volkovlabs/grafana-sms-webhook/blob/main/LICENSE). diff --git a/img/contact.png b/img/contact.png new file mode 100644 index 0000000..3dd9d8c Binary files /dev/null and b/img/contact.png differ