-
- 
@@ -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.