aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d69f67701c424d85b8c8cf82b45a2ea46ea4f9cd (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
25
26
27
28
29
30
31
32
33
34
35
36
# pomc: pomodoro daemon client

This program provides a basic CLI client for the [pomd](https://github.com/exvacuum/pomd) pomodoro daemon.

## Installation

### Via crates.io
```sh
cargo install pomc
```

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