github
/
statping
mirror of https://github.com/statping/statping
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Statup Plugins (markdown)

master
Hunter Long 2018-07-04 19:26:31 -07:00
parent 8555e875bc
commit 7904bc27fa
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Statup-Plugins.md

@ -7,7 +7,7 @@ go get github.com/hunterlong/statup/plugin
Start off with the [Example Statup Plugin](https://github.com/hunterlong/statup_plugin) that includes all the interfaces and some custom options for you to expand on. You can include any type of function in your own plugin!
<p align="center">
<img width="95%" src="https://s3-us-west-2.amazonaws.com/gitimgs/statuppluginrun.gif">
<img width="95%" src="https://img.cjx.io/statuppluginrun.gif">
</p>
## Building Plugins
@ -30,7 +30,7 @@ Statup includes a couple tools to help you on your Plugin journey, you can use `
statup test plugins
```
<p align="center">
<img width="75%" src="https://s3-us-west-2.amazonaws.com/gitimgs/statupplugintester.gif">
<img width="75%" src="https://img.cjx.io/statupplugintester.gif">
</p>
Your plugin should be able to parse and receive events before distributing it. The test tools creates a temporary database (SQLite) that your plugin can interact with. Statup uses [upper.io/db.v3](https://upper.io/db.v3) for database interactions. The database is passed to your plugin `OnLoad(db sqlbuilder.Database)`, so you can use the `db` variable passed here.