v/pingme
1
0
Fork 0
mirror of https://github.com/kha7iq/pingme.git synced 2025-05-28 04:30:08 -07:00
Code Issues Projects Releases Wiki Activity

docs: Updated documentation

Browse Source
This commit is contained in:
kha7iq 2021-04-14 20:48:25 +08:00
parent 4c4697815e
commit 218fac39d3
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,15 +1,23 @@
<h2 align="center">
<br>
<p align="center"><img width=30% src="https://github.com/kha7iq/pingme/blob/master/.github/img/logo.png"></p>
<p align="center"><img width=30% src="https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png"></p>
</h2>
<h4 align="center">PingMe CLI</h4>
<p align="center">
<a href="https://github.com/kha7iq/pingme/blob/master/LICENSE.md">
<img alt="License" src="https://img.shields.io/github/license/kha7iq/pingme?style=flat-square&logo=github&logoColor=white">
<a href="https://github.com/kha7iq/pingme/issues">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/kha7iq/pingme?style=flat-square&logo=github&logoColor=white">
<a href="https://github.com/kha7iq/pingme/releases">
<img alt="Release" src="https://img.shields.io/github/v/release/kha7iq/pingme">
<a href="#">
<img alt="Build" src="https://img.shields.io/github/workflow/status/kha7iq/pingme/goreleaser">
<a href="https://github.com/kha7iq/pingme/issues">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/kha7iq/pingme?style=flat-square&logo=github&logoColor=white">
<a href="https://github.com/kha7iq/pingme/blob/master/LICENSE.md">
<img alt="License" src="https://img.shields.io/github/license/kha7iq/pingme">
<a href="#">
<img alt="Go Version" src="https://img.shields.io/github/go-mod/go-version/kha7iq/pingme">
<a href="https://pkg.go.dev/github.com/kha7iq/pingme">
<img alt="Go Dev Reference" src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat">
</p>
<p align="center">
@ -26,13 +34,13 @@
## 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
**PingMe** is a personal project to satisfy my needs of having alerts, most major platforms have integration to send alerts
but its not always useful, either you are stuck with one particular 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.
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
Everything is configurable via environment 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.
@ -59,7 +67,7 @@ go get -u github.com/kha7iq/pingme
```
### Windows
Alternativly you can head over to [release pages](https://github.com/kha7iq/pingme/releases) and download the binary for windows & all other supported platforms.
Alternatively you can head over to [release pages](https://github.com/kha7iq/pingme/releases) and download the binary for windows & all other supported platforms.
## Usage
@ -95,7 +103,7 @@ Check [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more det
## Configuration
All the flags have crosponding enviornment variables assosiated with it. You can either provide the value with flags
All the flags have corresponding environment variables associated with it. You can either provide the value with flags
or export to a variable. View the [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.