doc: add README

This commit is contained in:
Sebastian Mark 2024-10-23 17:43:05 +02:00
parent 46d3e02f33
commit d83946e255

21
README.md Normal file
View 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.