diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..23deb3f --- /dev/null +++ b/readme.md @@ -0,0 +1,19 @@ +# cli-timer + +A quick and dirty commandline timer that I quickly threw together when I noticed that I didn't already have one. Probably could've been a powershell/bash script but eh I like doing things in rust and it's cross-platform this way. + +## Usage + +``` +> timer [hours]:[minutes]:[seconds] + +OR + +> timer [minutes]:[seconds] + +OR + +> timer [seconds] +``` + +The program prints the time remaining to stdout and exits once the time runs out.