aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 82a3386..a06a02a 100644
--- a/README.md
+++ b/README.md
@@ -5,21 +5,25 @@ Dumps and colorizes Jenkins RSS feeds.
## Usage
```
-usage: good_feeder [-h] [-a AUTH] [--insecure] [-l] [-f] [-s [SEARCH]] [-n] [--html] [-V] [jenkins_url]
+usage: good_feeder [-h] [-a AUTH] [-L] [--insecure] [--html] [-S SEP] [-l] [-f] [-s [SEARCH]] [-n] [-V] [jenkins_url]
+
+good_feeder v{vesion_here}
positional arguments:
- jenkins_url
+ jenkins_url URL to server, folder, or job
optional arguments:
-h, --help show this help message and exit
-a AUTH, --auth AUTH Format: "username:token" (or omit "-a" and use JENKINS_AUTH environment variable)
+ -L, --localtime Convert server UTC timestamp to local time
--insecure Disable SSL certificate verification
+ --html Output as html (i.e. email)
+ -S SEP, --sep SEP default string: 'ยป', max length: 2
-l, --latest Show only latest builds
-f, --failed Show only failed builds
-s [SEARCH], --search [SEARCH]
Filter output on sub-string (case-sensitive)
-n, --negate Negate search filter
- --html Output as html (i.e. email)
-V, --version Show version
```