toki/StartRNR
1
0
Fork 0
Code Issues Pull requests Activity

Add usage section to README

Browse source
This commit is contained in:
Kiana Sheibani 2023-12-16 00:18:35 -05:00
parent ebec5f086d
commit 47da06e3d6
Signed by: toki
GPG key ID: 6CB106C25E86A9F7
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -34,6 +34,30 @@ Alternatively, if you use Nix:
nix profile install github:kiana-S/StartRNR 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 <player>
# Analyze matchup of two players
startrnr player matchup <player1> <player2>
```
A player can be specified by their tag or by their
[discriminator](https://help.start.gg/en/articles/4855957-discriminators-on-start-gg).
## Configuration ## Configuration
StartRNR stores its rating databases in its config directory, which is located at: StartRNR stores its rating databases in its config directory, which is located at: