diff --git a/README.md b/README.md index f128ee9..a7eb614 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@
About •
- Documentation •
+ Documentation •
Supported Services •
Install •
Configuration •
@@ -27,18 +27,14 @@
## About
**PingMe** is a personal project to satisfy my needs of having alerts, most of major platforms have integration to send alerts
-
but its not always useful, either you are stuck with one particlaur platform or you have to do alot of integrations. I needed a small app
-
which i can just call from my backup scripts, cron jobs, CI/CD pipelines or from anywhere to send a message with particular information.
-
And i can ship it everywhere with ease.
+Hence the birth of PingMe.
-Everything should be configurable via enviornment variables and i can simply export the logs or messages to a variable which will be sent
-
-as message. And most of all this should serve as a swiss army knife sort of tool which supports multiple platforms.
+Everything is configurable via enviornment variables and you can simply export the logs or messages to a variable which will be sent
+as message. And most of all this serves as a swiss army knife sort of tool which supports multiple platforms.
-Hence the birth of PingMe.
## Supported services
@@ -95,21 +91,13 @@ GLOBAL OPTIONS:
--help, -h show help (default: false)
```
-
-### Telegram
-```bash
-pingme telegram --token "0125:AAFHvnYf_ABC" --msg "This is a new message ✈" --channel="-1001001001,-1002002001"
-```
-
-
-* ![Demo](https://github.com/kha7iq/pingme/blob/master/.github/img/pingme.gif)
-
+Check [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.
## Configuration
All the flags have crosponding enviornment variables assosiated with it. You can either provide the value with flags
-or export to a variable. View the [Documentation Page](https://github.com/) for more details
+or export to a variable. View the [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.
## Contributing
@@ -117,7 +105,6 @@ or export to a variable. View the [Documentation Page](https://github.com/) for
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/kha7iq/pingme/issues). You can also take a look at the [contributing guide](https://github.com/kha7iq/pingme/blob/master/CONTRIBUTING.md).
-
## Show your support
Give a ⭐️ if you like this project!