diff --git a/README.md b/README.md new file mode 100644 index 0000000..791e227 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# log\_happy + +Little log viewer that watches for the presence of absence of expected phrases +in log files. I found myself running programs with verbose logging output and +frequently using tmux's buffer search feature to look for the presence or +absence of specific text. It seemed useful to have a program that would scan +the output as it was generated instead of having to go back and manually +search later. That is what this tool does. + +`log_happy` allows you to specify a log file it wil read, or a command it will +execute and monitor. It also allows you to specify multiple regex's to expect +either to find or not find in the output. It displays clearly which patterns +where found and which were not and uses green and red text to show whether +each pattern's presence matches your expectation. + +## Usage + +`log_happy` online help: + + Usage: + log_happy [options] + log_happy [options] + log_happy [options] -- + + Options: + + -v Print version information and exit. + -e