diff --git a/README.md b/README.md index a48367a..9d4ec61 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,84 @@ -# tlock +

+
+ +
+ tlock +
+

-*⚠️ Work in progress!* +

Fully customizable terminal clock.

-Fully customizable cross-platform clock for the terminal. +

+ + + +

+ + +
+ +## Description + +This is a fully customizable terminal clock written in Rust. You can change de colors, the format and you can even use multiples modes: clock, chronometer and timer. + +
+ +## Installation + +```bash +$ cargo install --git https://github.com/pihkaal/tlock.git +``` + +
+ +## How to use + +```bash +# Help +$ tlock --help + +# Clock mode +$tlock + +# Debug mode (print current configuration) +$ tlock debug + +# Chronometer mode +$ tlock chrono + +# Timer mode +$ tlock timer 4h 12m 30s +``` + +
+ +## Configuration + +Configuration is stored under `~/.config/tlock/config`, it is generated by the program if it doesn't exist. +You can regenerate this configuration at any time by running: + +```bash +$ tlock --regenerate-default +``` + +You can use multiple configuration files thanks to the `--config` flag: + +```bash +$ tlock --config /path/to/my/config +``` + +The configuration itself contains comments to help you understand how to customize it. + +
+ +## License + +This project is MIT licensed.