Add USAGE.md

Signed-off-by: Edu4rdSHL <edu4rdshl@protonmail.com>
This commit is contained in:
Edu4rdSHL 2021-06-09 19:58:41 -05:00
parent 4f276e98b3
commit e1c373cd06
No known key found for this signature in database
GPG key ID: 3A574A4009F553E5

21
docs/USAGE.md Normal file
View file

@ -0,0 +1,21 @@
# Usage
- Watch multiple files from a configuration file:
```
$ webtail-rs -c webtail.conf
```
See the [config example](https://github.com/Edu4rdSHL/webtail-rs/blob/master/examples/webtail.conf).
- Watch only a file in an specific port:
```
$ webtail-rs -f file.txt -p 9090
```
- Set an different delay in seconds. Delay is the time it takes for the file updates to be displayed in the browser.
```
$ webtail-rs -f file.txt -p 9090 -d 10 # Updates the content every 10 seconds.
```