add readme

This commit is contained in:
Adrian Hedqvist 2023-08-09 23:00:31 +02:00
parent 63adf7d53e
commit fec8bccd82

19
readme.md Normal file
View file

@ -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.