quick change to readme

DnOberon · Oct 15, 2019 · 35727d6 · 35727d6
1 parent f4a7c7a
commit 35727d6
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 17 deletions.
diff --git a/dist/CHANGELOG.md b/dist/CHANGELOG.md
@@ -1,8 +1,3 @@
 ## Changelog
 
-195495e Fixed package main
-9f78eab corrections to gorelease
-c6ca24b doc changes
-dd11a2b hacky, but done - refactor coming
-b061776 quick cleanup to the tool
-21d9f48 updated readme for release
+f4a7c7a fix the release
diff --git a/dist/checksums.txt b/dist/checksums.txt
@@ -1,5 +1,5 @@
-7c77cb6bfb4415dc2cf03c72944bf6716903ef3b0919cc312eab9f2d1e89a281  heimdall_v1.0.1-next_freebsd_i386.tar.gz
-4c01047af48a797973e8ca18bf699e2b538085ca3ca74a2619162e5a8abc62f7  heimdall_v1.0.1-next_freebsd_armv6.tar.gz
-c399d20ed6327a20206d9125c3bd255009a6fbfb8d26db88cfac1990fb1af3e9  heimdall_v1.0.1-next_freebsd_x86_64.tar.gz
-31cb56807e499751f3bcb67a6069f2c1a1791d586ff8d60752ec0b03560a6f4d  heimdall_v1.0.1-next_Windows_x86_64.zip
-fd4f8b9e711df2ef50fe7c68ec52440731976d4d7ee63c2f2e7a65bd1cbc3687  heimdall_v1.0.1-next_Windows_i386.zip
+78daa137f5b6e025cce8396169d6e6033f668ad40024875e7532a00d620da7eb  heimdall_1.0.2_freebsd_armv6.tar.gz
+b025427ecbaf807f99ac9906c1fbb9a2e82c15de9cf2fe349aed1439ce31f731  heimdall_1.0.2_Windows_i386.zip
+e6490ec74193c2c777e5703872c8fe4274eb7d8c40b606e3761d20cd5f0ad6ed  heimdall_1.0.2_freebsd_i386.tar.gz
+1a7eee6fec4f8412679ed48720611722cb8b1a8e77fe19ddc7b219bd3a4e13ce  heimdall_1.0.2_Windows_x86_64.zip
+4434ca5940f857393dcdb6f6cb6fceda1f92009dba2e1871817c7fc0cab14c1a  heimdall_1.0.2_freebsd_x86_64.tar.gz
diff --git a/dist/heimdall_darwin_386/heimdall b/dist/heimdall_darwin_386/heimdall
diff --git a/dist/heimdall_darwin_amd64/heimdall b/dist/heimdall_darwin_amd64/heimdall
diff --git a/dist/heimdall_linux_386/heimdall b/dist/heimdall_linux_386/heimdall
diff --git a/dist/heimdall_linux_amd64/heimdall b/dist/heimdall_linux_amd64/heimdall
diff --git a/readme.md b/readme.md
@@ -2,6 +2,14 @@
 ----
 [![GoDoc](https://godoc.org/github.com/DnOberon/heimdall/bifrost?status.svg)](https://godoc.org/github.com/DnOberon/heimdall/bifrost)
 
+Heimdall allows you to manage and monitor command line applications. Provided with an executable or command to run `heimdall` can perform the following operations:
+
+* Repeat the command n times
+* Run command in parallel in n instances
+* Log command's output
+* Filter and log command's output
+* Kill hung applications through user specified timeout
+
 
 
 ## Install
@@ -29,12 +37,15 @@ Usage:
   heimdall [flags]
 
 Flags:
-  -h, --help               help for heimdall
-  -l, --log                Toggle logging of provided program's stdout and stderr output to file
-  -f, --logFilter string   Allows for log filtering via regex string. Use only valid with log flag
-  -r, --repeat int         Designate how many times to repeat your program with supplied arguments
-  -t, --timeout duration   Designate when to kill your provided program
-  -v, --verbose            Toggle display of provided program's stdout and stderr output while heimdall runs
+  -h, --help                help for heimdall
+  -l, --log                 Toggle logging of provided program's stdout and stderr output to file, appends if file exists
+      --logFilter string    Allows for log filtering via regex string. Use only valid with log flag
+      --logName string      Specify the log file name, defaults to heimdall.log (default "heimdall.log")
+      --logOverwrite        Toggle logging of provided program's stdout and stderr output to file
+  -p, --parallelCount int   Designate how many times to repeat your program with supplied arguments (default 1)
+  -r, --repeat int          Designate how many times to repeat your program with supplied arguments (default 1)
+  -t, --timeout duration    Designate when to kill your provided program
+  -v, --verbose             Toggle display of provided program's stdout and stderr output while heimdall runs
 
 ```