Merge pull request #2 from EGT-Ukraine/readme

readme updated

Author: Vyacheslav Pryimak

README.md

@@ -1 +1,27 @@
-# gitlab-trigger-watcher
+gitlab-trigger-watcher [![Build Status](https://travis-ci.org/EGT-Ukraine/gitlab-trigger-watcher.svg?branch=master)](https://travis-ci.org/EGT-Ukraine/gitlab-trigger-watcher)
+---
+
+Application to check Gitlab trigger's pipeline status
+
+### Build and run
+```bash
+make build
+./gitlab-trigger-watcher -h
+```
+
+options:
+  * `--privateToken` - user's personal private token;
+  * `--token` - project token;
+  * `--projectID` - integer ID of your project;
+  * `--skipVerifyTLS` - (optional) skip to verify tls certificate;
+  * `--host` - (optional) set your custom Gitlab's host;
+  * `--schema` - (optional. default: https) set http or https connection type;
+  * `--ref` - (optional) branch for the project. (default: master);
+  * `--urlPrefix` - (optional) if you are use some prefix for your Gitlab (final URL will be looked like: /prefix/api/v4/...);
+  * `--variables` - (optional) custom variables for the project (format example: `variable1:value,variable2:value`)
+  
+### Run:
+
+```bash
+./gitlab-trigger-watcher --privateToken ${PRIVATE_TOKEN} --token ${TOKEN} --host gitlab.egt.com --projectID 123 run
+```

main.go

@@ -49,10 +49,12 @@ func main() {
 			},
 			cli.StringFlag{
 				Name:  "privateToken",
+				Usage: "your personal private token",
 				Value: "",
 			},
 			cli.StringFlag{
 				Name:  "token",
+				Usage: "project token",
 				Value: "",
 			},
 			cli.StringSliceFlag{