From 46e6d482e8b93e6751dbc44b1c8f9abede2b186f Mon Sep 17 00:00:00 2001 From: Dmitriy Pleshevskiy Date: Fri, 18 Feb 2022 23:44:43 +0300 Subject: [PATCH] chore(doc): update information about config --- readme.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index e3d6985..9ce965f 100644 --- a/readme.md +++ b/readme.md @@ -11,4 +11,17 @@ cargo install hwt_ui ## Usage -Type `hwt` in the terminal. +Type `hwt` in the terminal and the status window of the timers will open with +the default parameters + +```sh +hwt +``` + +If you want to customize the timers, you can create a configuration file based +on [the example](./config.example.toml). Then pass path to your configuration +file as additional parameter. + +```sh +hwt ./config.example.toml +```