bennetgallein/cachet-monitor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Matej Kramny
2017-02-12 19:50:03 -08:00
parent e6d8d31fa5
commit 698781afec
2 changed files with 2 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cli/main.go
View File

@@ -23,7 +23,6 @@ const usage = `cachet-monitor
Usage: Usage:
cachet-monitor (-c PATH | --config PATH) [--log=LOGPATH] [--name=NAME] [--immediate] cachet-monitor (-c PATH | --config PATH) [--log=LOGPATH] [--name=NAME] [--immediate]
cachet-monitor -h | --help | --version cachet-monitor -h | --help | --version
cachet-monitor print-config
Arguments: Arguments:
PATH path to config.json PATH path to config.json
@@ -39,7 +38,6 @@ Options:
-h --help Show this screen. -h --help Show this screen.
--version Show version --version Show version
--immediate Tick immediately (by default waits for first defined interval) --immediate Tick immediately (by default waits for first defined interval)
print-config Print example configuration
Environment varaibles: Environment varaibles:
CACHET_API override API url from configuration CACHET_API override API url from configuration

6
readme.md
View File

@@ -12,7 +12,7 @@
## Example Configuration ## Example Configuration
**Note:** configuration can be in json or yaml format. See `example.config.*` files. **Note:** configuration can be in json or yaml format. [`example.config.json`](https://github.com/CastawayLabs/cachet-monitor/blob/master/example.config.json), [`example.config.yaml`](https://github.com/CastawayLabs/cachet-monitor/blob/master/example.config.yml) files.
```yaml ```yaml
api: api:
@@ -94,7 +94,6 @@ pro tip: run in background using `nohup cachet-monitor 2>&1 > /var/log/cachet-mo
Usage: Usage:
cachet-monitor (-c PATH | --config PATH) [--log=LOGPATH] [--name=NAME] [--immediate] cachet-monitor (-c PATH | --config PATH) [--log=LOGPATH] [--name=NAME] [--immediate]
cachet-monitor -h | --help | --version cachet-monitor -h | --help | --version
cachet-monitor print-config
Arguments: Arguments:
PATH path to config.json PATH path to config.json
@@ -110,7 +109,6 @@ Options:
-h --help Show this screen. -h --help Show this screen.
--version Show version --version Show version
--immediate Tick immediately (by default waits for first defined interval) --immediate Tick immediately (by default waits for first defined interval)
print-config Print example configuration
Environment varaibles: Environment varaibles:
CACHET_API override API url from configuration CACHET_API override API url from configuration
@@ -120,7 +118,7 @@ Environment varaibles:
## Templates ## Templates
This package makes use of [`text/template`](https://godoc.org/text/template). This package makes use of [`text/template`](https://godoc.org/text/template). [Default HTTP template](https://github.com/CastawayLabs/cachet-monitor/blob/master/http.go#L14)
The following variables are available: The following variables are available: