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-03 14:38:56 -07:00
parent d938a6f60a
commit a79de42631
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Statup-Plugins.md

@ -1,4 +1,4 @@
Since Statup is built in Go Language we can use the go plugin feature to create dynamic plugins that run on load. Statup has an event anytime anything happens, you can create your own plugins and do any type of function. To implement your own ideas into Statup, use the plugin using the [statup/plugin](https://github.com/hunterlong/statup/blob/master/plugin/main.go) package.
Since Statup is built in Go Language we can use the [Go Plugin](https://golang.org/pkg/plugin/) feature to create dynamic plugins that run on load. Statup has an event anytime anything happens, you can create your own plugins and do any type of function. To implement your own ideas into Statup, use the plugin using the [statup/plugin](https://github.com/hunterlong/statup/blob/master/plugin/main.go) package.
```
go get github.com/hunterlong/statup/plugin
```
@ -14,6 +14,7 @@ git clone https://github.com/hunterlong/statup_plugin
cd statup-plugin
go build -buildmode=plugin -o example.so
```
###### Insert `example.so` into the `plugins` directory and reload Statup
## Statup Plugin Interface
Please remember Golang plugin's are very new and Statup plugin package may change and 'could' brake your plugin.
@ -76,3 +77,7 @@ func (p pkg) OnLoad(db sqlbuilder.Database) {
## Custom HTTP Routes
Plugin's can include their own HTTP route to accept GET/POST requests.
## Plugin To-Do List
- [ ] Ability to read/write to database
- [ ] Ability to includes assets like jpg, json, etc