diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2019-01-05 15:34:14 -0800 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2019-01-05 15:34:14 -0800 |
| commit | d02ee056d1d1a39f583d41c6b6cb3b1f985e5878 (patch) | |
| tree | 4641c8811f9982c595cde880de78140ebe6ff193 /README.md | |
| parent | 8e65fed76ab3ea2c1d7cee92c9272f939b231506 (diff) | |
Added readme/license and better -p flag
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f4237ae --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# nowopen + +`nowopen` is a simple program to display which places are currently open. + +## Usage + +First, create a file with business hours in it at either `~/.local/share/nowopen/businesshours` +(recommended) or `~/.businesshours`. An example businesshours file is provided. +The format looks like: + +``` +Mario Bros Plumbing (plumbers): + 7am-6:30pm + sun: closed +``` + +Once you have a businesshours file, run `nowopen [-p] [tag1 tag2...]`. Establishments +matching any of the specified tags (prefix matching is used) and the amount of +time till they close will be displayed. E.g. `nowopen plumber` will show how long +"Mario Bros Plumbing" is open. The "-p" flag can be used to print plain text to +stdout instead of displaying in a temporary display with colors. |