diff --git a/README.md b/README.md index 48da51e..be80ea9 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,26 @@ fuck. ```sh $ ./main.py -h -usage: hhirlstats [-h] [-v] [-c] [-Q {gametime,moves,nicknames,playtime,usage}] [replay ...] +usage: hhirlstats [-h] [-v] [-C] [-o FILE] replay [replay ...] + +extracts stats from a Showdown replay + +positional arguments: + replay replay ID or URL + +options: + -h, --help show this help message and exit + -v, --verbose add debugging info (default: None) + -C, --no-cache fetch replays instead of using cache (default: False) + -o FILE, --output FILE + output data file (default: data.db) ``` -Recommended to cache replays (`-c`) to save issuing requests to Showdown on every query. +Replay files are cached after they're downloaded for the first time save issuing +requests to Showdown on every new run. -Run the program once with all your replays (or once for each replay), then start querying. +Run the program once with all your replays (or once for each replay), then run +whatever SQL queries against the data file (default `data.db`) you want. ## Future work