diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f5096d --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Bar weather + +Simple tool written in Rust to query weather + +# Description + +* Tool uses weather.gov API to query weather + +# Usage + +* Use the `--help` option for usage information: + +```sh +Usage: bar_weather [OPTIONS] + +Options: + -s, --station Name of the weather station [default: khio] + -m, --metric Use Metric units. Imperial units otherwise + -h, --help Print help + -V, --version Print version +```