From 3818be41eb9079ec5cc658a3e54ae614b4fd9a8b Mon Sep 17 00:00:00 2001 From: Brian Lee Date: Tue, 9 Jul 2024 16:08:08 -0700 Subject: [PATCH] Add examples to readme. --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bc306e0..b6acd62 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,40 @@ player_scores_by_stars leaderboard_songs_by_stars ``` -### Example +### Examples ```sh -Enter the playerid (Default: 76561199407393962): -Enter the minimum starlevel to include on the playlist (Default: 5): 6 -Enter the maximum starlevel to include on the playlist (Default: 7.0): -Enter the filename for the playlist (Default: Replay SS 6.0★): +leaderboard_songs_by_stars +Enter the minimum starlevel to include on the playlist (Default: 6.0): 6.2 +Enter the maximum starlevel to include on the playlist (Default: 6.3): +Enter the filename for the playlist (Default: SS Leaderboard 6.2★): +2024-07-09 16:06:13 DEBUG: Using selector: EpollSelector +2024-07-09 16:06:13 INFO: Fetching page 1/-1 of leaderboards +2024-07-09 16:06:13 INFO: Got 14 songs from leaderboard page 1 +2024-07-09 16:06:13 INFO: Fetching page 2/3 of leaderboards +2024-07-09 16:06:14 INFO: Got 14 songs from leaderboard page 2 +2024-07-09 16:06:14 INFO: Fetching page 3/3 of leaderboards +2024-07-09 16:06:14 INFO: Got 3 songs from leaderboard page 3 +2024-07-09 16:06:14 INFO: Playlist written to SS Leaderboard 6.2★.bplist ``` -Creates a playlist called `Replay SS 6.0★.bplist` +Player songs by stars: + +```sh +player_scores_by_stars +2024-07-09 16:07:04 DEBUG: Using selector: EpollSelector +Enter the playerid (Default: 76561199407393962): +Enter the minimum starlevel to include on the playlist (Default: 5): +Enter the maximum starlevel to include on the playlist (Default: 6.0): 5.5 +Enter the filename for the playlist (Default: Replay SS 5.0★): +2024-07-09 16:07:14 INFO: Fetching page 1/-1 of player scores +2024-07-09 16:07:15 INFO: Got 100 scores from page 1 +... +2024-07-09 16:07:19 INFO: Fetching page 8/9 of player scores +2024-07-09 16:07:20 INFO: Got 96 scores from page 8 +2024-07-09 16:07:20 INFO: Playlist written to Replay SS 5.0★.bplist + +``` ## Development