diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c0b83e2 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Listimer + +Simple timer meant to be displayed in a sway-bar status. + +## Usage + +Start the timer with the `start` subcommand. + +```sh +$ listimer start <number of minutes> +``` + +Restart the timer with the `restart` subcommand. + +```sh +$ listimer restart +``` + +Stop the timer with the `stop` subcommand. + +```sh +$ listimer stop +``` + +Query the timer with the `query` subcommand. + +```sh +$ listimer query +``` + +The command will output [pango +markup](https://docs.gtk.org/Pango/pango_markup.html). To use it with sway-bar +be sure to enable the `pango_markup` sway-bar option. |