Updated README with initial information
This commit is contained in:
parent
f744922be1
commit
480ba07c45
23
README.md
23
README.md
@ -1,3 +1,22 @@
|
|||||||
# unibar
|
# Unibar
|
||||||
|
|
||||||
A tool that returns variety of components in a string suitable to use in a status bar
|
Simple bar written in Rust
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
* A tool that returns variety of components in a string suitable to use in a
|
||||||
|
status bar
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
* Use the `--help` option for usage information:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
Usage: unibar [OPTIONS]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-s, --weather_station <STATION> Name of the weather station [default: khio]
|
||||||
|
-m, --weather_metric Use Metric units. Imperial units otherwise
|
||||||
|
-h, --help Print help
|
||||||
|
-V, --version Print version
|
||||||
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user