aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ed27ba157d6a9fa9564b058fe9dea7cb620bd358 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# nowopen

`nowopen` is a simple program to display which places are currently open.

## 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`.
An example businesshours file is provided, so you can get started by
running `mkdir -p ~/.local/share/nowopen && cp example_businesshours ~/.local/share/nowopen/businesshours`.
The businesshours format looks like:

```
Mario Bros Plumbing (plumbers):
    7am-6:30pm
    sun: closed
```

## 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.