generated from PlexSheep/rs-base
update readme
This commit is contained in:
parent
23e6ab9ea8
commit
649cc89069
1 changed files with 18 additions and 1 deletions
19
README.md
19
README.md
|
@ -16,7 +16,12 @@ A clock app in terminal. It support the following modes:
|
|||
|
||||
# Usage
|
||||
|
||||
## Help inforamtion
|
||||
## Basic usage
|
||||
|
||||
```shell
|
||||
$ tclock
|
||||
```
|
||||
Run this command to start a clock, and press `q` to exit.
|
||||
|
||||
```shell
|
||||
$ tclock --help
|
||||
|
@ -62,6 +67,18 @@ You can use `-s` or `--size` option to custome clock size, for example:
|
|||
$ tclock -s 2
|
||||
```
|
||||
|
||||
* Color
|
||||
|
||||
You can use `-c` or `--color` to set clock forground color, for exmaple:
|
||||
|
||||
```shell
|
||||
# color name
|
||||
$ tclock -c yellow
|
||||
|
||||
# or hex color
|
||||
$ tclock -c '#e63946'
|
||||
```
|
||||
|
||||
# License
|
||||
|
||||
MIT License.
|
||||
|
|
Reference in a new issue