Updated Notifiers (markdown)

master
Hunter Long 2018-12-04 00:09:04 -08:00
parent 078650efca
commit 0ba05a0c9a
1 changed files with 3 additions and 3 deletions

@ -5,8 +5,8 @@
Statping includes multiple Notifiers to alert you when your services are offline. You can also create your own notifier and send a Push Request to this repo! Creating a custom notifier is pretty easy as long as you follow the requirements. A notifier will automatically be installed into the users Statping database, and form values will save without any hassles. 💃 Statping includes multiple Notifiers to alert you when your services are offline. You can also create your own notifier and send a Push Request to this repo! Creating a custom notifier is pretty easy as long as you follow the requirements. A notifier will automatically be installed into the users Statping database, and form values will save without any hassles. 💃
<p align="center"> <p align="center">
<a href="https://github.com/hunterlong/statup/wiki/Notifier-Example">Example Code</a> | <a href="https://github.com/hunterlong/statup/wiki/Notifier-Events">Events</a> | <a href="https://github.com/hunterlong/statup/tree/master/notifiers">View Notifiers</a><br> <a href="https://github.com/hunterlong/statping/wiki/Notifier-Example">Example Code</a> | <a href="https://github.com/hunterlong/statping/wiki/Notifier-Events">Events</a> | <a href="https://github.com/hunterlong/statping/tree/master/notifiers">View Notifiers</a><br>
<a href="https://godoc.org/github.com/hunterlong/statup/core/notifier"><img src="https://godoc.org/github.com/golang/gddo?status.svg"></a> <a href="https://godoc.org/github.com/hunterlong/statping/core/notifier"><img src="https://godoc.org/github.com/golang/gddo?status.svg"></a>
</p> </p>
## Notifier Requirements ## Notifier Requirements
@ -16,7 +16,7 @@ Statping includes multiple Notifiers to alert you when your services are offline
- Should have a form for user to input their variables/keys. `Form: []notifier.NotificationForm` - Should have a form for user to input their variables/keys. `Form: []notifier.NotificationForm`
## Notifier Interface (required) ## Notifier Interface (required)
Statping has the `Notifier` interface which you'll need to include in your notifier. Statping includes many other events/triggers for your notifier, checkout <a href="https://github.com/hunterlong/statup/wiki/Notifier-Events">Notifier Events</a> to see all of them. Statping has the `Notifier` interface which you'll need to include in your notifier. Statping includes many other events/triggers for your notifier, checkout <a href="https://github.com/hunterlong/statping/wiki/Notifier-Events">Notifier Events</a> to see all of them.
```go ```go
// Notifier interface is required to create a new Notifier // Notifier interface is required to create a new Notifier
type Notifier interface { type Notifier interface {