some more docs

fatz · Dec 6, 2016 · 3ac9b08 · 3ac9b08
1 parent 1808888
commit 3ac9b08
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,11 +3,21 @@ a small go project for having a the current state of your icinga2 monitoring on
 
 It needs an user/password to the icinga api.
 
-
 ## State
 this is a really small and fast project the current state works for us but might need some improvement. Let me know if you've ideas or just send pull requests.
 
+```
+target/simpleview.darwin.amd64 -help
+Usage of target/simpleview.darwin.amd64:
+  -icingaendpoint="http://api-icinga2.mycompany.example.com:5665": the url to the icinga2 api
+  -icingapassword="password": password
+  -icingausername="simpleview": username to authenticate against icinga
+  -projects="": filter on this comma-sep. list of projects
+```
+
+__projects:__ the projects options is currently not implemented
 
+All commandline options can also be set through environment variables `SIMPLEVIEW_$var`
 
 # License
 ```