From 47da06e3d632a2e3bcf7f5fb84f8af375d5083f6 Mon Sep 17 00:00:00 2001 From: Kiana Sheibani Date: Sat, 16 Dec 2023 00:18:35 -0500 Subject: [PATCH] Add usage section to README --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 075b9a2..f075999 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,30 @@ Alternatively, if you use Nix: nix profile install github:kiana-S/StartRNR ``` +## Usage + +Once StartRNR is installed, run: + +``` sh +startrnr sync +``` + +The program will walk you through creating a dataset, then run its rating +algorithm. **This may take up to a few hours to finish running!** + +Once the rating data has been generated, these commands can be used to access it: + +``` sh +# Access a player's data +startrnr player info + +# Analyze matchup of two players +startrnr player matchup +``` + +A player can be specified by their tag or by their +[discriminator](https://help.start.gg/en/articles/4855957-discriminators-on-start-gg). + ## Configuration StartRNR stores its rating databases in its config directory, which is located at: