diff options
-rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e52447 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# pomc: pomodoro daemon client + +This program provides a basic CLI client for the [pomd](https://github.com/exvacuum/pomd) pomodoro daemon. + +## Installation +### From Source +```sh +cargo install --path . +``` + +## Usage +``` +Usage: pomc <COMMAND> + +Commands: + start + pause + stop + skip + get-iteration + get-remaining + is-running + is-on-break + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help Print help + -V, --version Print version +``` +This program could be used in statusbars to monitor pomd status, as well as used directly from a terminal to control the timer. |