aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2021-10-19 12:51:48 -0700
committerBruce Hill <bruce@bruce-hill.com>2021-10-19 12:51:48 -0700
commitfd5eecdb3a63253940432d539017f03ec3d20e1c (patch)
tree4a737a2cee1f8de7bb97d7c60e9f48ed27cba36e /README.md
parent72f49aa40a5de63a1abc6b113558332a601b6c83 (diff)
Minor cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 13 insertions, 5 deletions
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.