diff --git a/README.md b/README.md index 990f290..7db9143 100644 --- a/README.md +++ b/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 \ No newline at end of file +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 Name of the weather station [default: khio] + -m, --weather_metric Use Metric units. Imperial units otherwise + -h, --help Print help + -V, --version Print version +```