From fd5eecdb3a63253940432d539017f03ec3d20e1c Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Tue, 19 Oct 2021 12:51:48 -0700 Subject: Minor cleanup --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d68dc45..80e36df 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ ![Preview](https://bitbucket.org/spilt/nowopen/downloads/nowopen_preview.gif) ## Installing + `sudo make install` to install, and `sudo make uninstall` to uninstall. You should also create a file to store business hours in at either `~/.local/share/nowopen/businesshours` (recommended) or `~/.businesshours`. @@ -19,8 +20,15 @@ Mario Bros Plumbing (plumbers): ``` ## Usage -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. + +Once you have a businesshours file, run `nowopen [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. + +### Flags + +- `-h`/`--help`: Print the usage and exit. +- `-w`/`--where`: Print where the config file is stored and exit. +- `-r`/`--random`: Pick a single random option. +- `-p`/`--plain`: Print the results to stdout in plain text. -- cgit v1.2.3