diff --git a/README.md b/README.md index 9d4ec61..52557ec 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,28 @@ -

-
- -
- tlock -
-

+
+

tlock

+ demo +
-

Fully customizable terminal clock.

+Fully customizable clock for the terminal. You can change de colors, the format and you can even use multiples modes: clock, chronometer and timer. -

- - - -

+## What it does - +- Clock mode, with customizable date display +- Chronometer mode, with lap logging +- Timer mode +- Debug mode (prints your configuration) -
+## Next features -## 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. - -
+- Customizable font +- Hot reloadable config ## Installation ```bash -$ cargo install --git https://github.com/pihkaal/tlock.git +$ cargo install --git https://git.pihkaal.me/pihkaal/tlock.git ``` -
- ## How to use ```bash @@ -58,8 +42,6 @@ $ tlock chrono $ tlock timer 4h 12m 30s ``` -
- ## Configuration Configuration is stored under `~/.config/tlock/config`, it is generated by the program if it doesn't exist. @@ -72,13 +54,11 @@ $ tlock --regenerate-default You can use multiple configuration files thanks to the `--config` flag: ```bash -$ tlock --config /path/to/my/config +$ tlock --config /path/to/your/config ``` The configuration itself contains comments to help you understand how to customize it. -
- ## License This project is MIT licensed. diff --git a/docs/demo.gif b/docs/demo.gif new file mode 100644 index 0000000..c9a1f7c Binary files /dev/null and b/docs/demo.gif differ