v/pingme
1
0
Fork 0
mirror of https://github.com/kha7iq/pingme.git synced 2025-05-16 06:40:12 -07:00
Code Issues Projects Releases Wiki Activity

docs: updated documentation

Browse Source
This commit is contained in:
kha7iq 2021-04-14 17:58:37 +08:00
parent fc3cbf2034
commit 2a1ae8abbd
1 changed files with 7 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -14,7 +14,7 @@
<p align="center">
<a href="#about">About</a> •
<a href="#about">Documentation</a> •
<a href="https://kha7iq.github.io/docs-pingme/#/">Documentation</a> •
<a href="#supported-services">Supported Services</a> •
<a href="#install">Install</a> •
<a href="#configuration">Configuration</a> •
@ -27,19 +27,15 @@
## 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.
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.
Hence the birth of PingMe.
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.
## Supported services
- *Discord*
@ -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!<br />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!