Add to readme, remove comment

This commit is contained in:
Matej Kramny
2016-05-19 19:26:29 +01:00
parent 6e9f5440ba
commit 9d0e176695
2 changed files with 9 additions and 3 deletions

View File

@@ -82,3 +82,10 @@ We made this tool because we felt the need to have our own monitoring software (
The idea is a stateless program which collects data and pushes it to a central cachet instance.
This gives us power to have an army of geographically distributed loggers and reveal issues in both latency & downtime on client websites.
Package usage
-------------
When using `cachet-monitor` as a package in another program, you should follow what `cli/main.go` does. It is important to call `ValidateConfiguration` on `CachetMonitor` and all the monitors inside.
[API Documentation](https://godoc.org/github.com/CastawayLabs/cachet-monitor)