diff --git a/README.md b/README.md index c58d1b9..3ec89a3 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,19 @@ Checks available MAME Torrents on PleasureDome and updates the local versions if more recent -versions are detected \ No newline at end of file +versions are detected + +![Sample output](https://djib.fr/djib/PDMameUpdate/raw/branch/master/screenshot.png) + +## Usage +```shell +usage: PDMameUpdate.py [-h] [-l] [-d] [-c] + +Update PleasureDome MAME Torrents + +optional arguments: + -h, --help show this help message and exit + -l, --log Display more log messages + -d, --debug Display debugging messages + -c, --countdown Start with a 5 second countdown +```