PlexSheep/crock
Archived
1
0
Fork 0
generated from PlexSheep/rs-base
Code Issues 7 Pull requests Projects Releases 9 Packages 1 Wiki Activity

update readme

Browse source
This commit is contained in:
race604 2022-07-19 17:11:47 +08:00
parent 23e6ab9ea8
commit 649cc89069
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -16,7 +16,12 @@ A clock app in terminal. It support the following modes:
# Usage # Usage
## Help inforamtion ## Basic usage
```shell
$ tclock
```
Run this command to start a clock, and press `q` to exit.
```shell ```shell
$ tclock --help $ tclock --help
@ -62,6 +67,18 @@ You can use `-s` or `--size` option to custome clock size, for example:
$ tclock -s 2 $ 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 # License
MIT License. MIT License.