doc: add README
This commit is contained in:
parent
46d3e02f33
commit
d83946e255
1 changed files with 21 additions and 0 deletions
21
README.md
Normal file
21
README.md
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
# ChronoTomato
|
||||||
|
|
||||||
|
A GoTomato command line client written in Go
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
`ChronoTomato` can be configured via CLI parameters or a config file.
|
||||||
|
|
||||||
|
The configuration is loaded from `~/config/ChronoTomato.yml`, here is an example:
|
||||||
|
```
|
||||||
|
url: ws://localhost:8080/ws
|
||||||
|
password: ""
|
||||||
|
config:
|
||||||
|
work: 1500
|
||||||
|
shortbreak: 300
|
||||||
|
longbreak: 600
|
||||||
|
sessions: 4
|
||||||
|
```
|
||||||
|
|
||||||
|
The `url` must be passed either via parameter or config file.
|
||||||
|
The `password` and the `config` are optional, the later can only be set via the configuration file.
|
Loading…
Reference in a new issue