diff --git a/README.md b/README.md new file mode 100644 index 0000000..e5834b2 --- /dev/null +++ b/README.md @@ -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.