chore: update README
This commit is contained in:
50
README.md
50
README.md
@@ -1,44 +1,28 @@
|
||||
<h1 align="center">
|
||||
<br>
|
||||
<img src="https://i.imgur.com/EeTzHDR.png" width="200">
|
||||
<br>
|
||||
tlock
|
||||
<br>
|
||||
</h1>
|
||||
<div align="center">
|
||||
<h1>tlock</h1>
|
||||
<img src="docs/demo.gif" alt="demo" />
|
||||
</div>
|
||||
|
||||
<h4 align="center">Fully customizable terminal clock.</h4>
|
||||
Fully customizable clock for the terminal. You can change de colors, the format and you can even use multiples modes: clock, chronometer and timer.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.rust-lang.org">
|
||||
<img src="https://img.shields.io/badge/rust-f54b00?style=for-the-badge&logo=rust&logoColor=white">
|
||||
</a>
|
||||
</p>
|
||||
## What it does
|
||||
|
||||
<p align="center" id="links">
|
||||
<a href="#description">Description</a> •
|
||||
<a href="#installation">Installation</a> •
|
||||
<a href="#how-to-use">How to use</a> •
|
||||
<a href="#configuration">Configuration</a> •
|
||||
<a href="https://pihkaal.me">Visit it</a> •
|
||||
<a href="#license">License</a>
|
||||
</p>
|
||||
- Clock mode, with customizable date display
|
||||
- Chronometer mode, with lap logging
|
||||
- Timer mode
|
||||
- Debug mode (prints your configuration)
|
||||
|
||||
<br>
|
||||
## 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.
|
||||
|
||||
<br>
|
||||
- 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
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
## How to use
|
||||
|
||||
```bash
|
||||
@@ -58,8 +42,6 @@ $ tlock chrono
|
||||
$ tlock timer 4h 12m 30s
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
## 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.
|
||||
|
||||
<br>
|
||||
|
||||
## License
|
||||
|
||||
This project is <a href="https://opensource.org/licenses/MIT">MIT</a> licensed.
|
||||
|
||||
Reference in New Issue
Block a user