Self-Hosted
/
pingme
mirror of https://github.com/kha7iq/pingme
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: updated documentation

Browse Source
pull/4/head
kha7iq 4 years ago
parent fc3cbf2034
commit 2a1ae8abbd
1 changed files with 6 additions and 19 deletions
Show Stats Download Patch File Download Diff File

25
README.md
Unescape View File

@ -14,7 +14,7 @@
<p align="center"> <p align="center">
<a href="#about">About</a> • <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="#supported-services">Supported Services</a> •
<a href="#install">Install</a> • <a href="#install">Install</a> •
<a href="#configuration">Configuration</a> • <a href="#configuration">Configuration</a> •
@ -27,18 +27,14 @@
## About ## About
**PingMe** is a personal project to satisfy my needs of having alerts, most of major platforms have integration to send alerts **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 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. 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. 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 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.
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.
## Supported services ## Supported services
@ -95,21 +91,13 @@ GLOBAL OPTIONS:
--help, -h show help (default: false) --help, -h show help (default: false)
``` ```
Check [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.
### 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)
## Configuration ## Configuration
All the flags have crosponding enviornment variables assosiated with it. You can either provide the value with flags 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 ## 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). 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 ## Show your support
Give a ⭐️ if you like this project! Give a ⭐️ if you like this project!

Write Preview
Loading…
Cancel
Save