diff --git a/README.md b/README.md index 2cf626f..b980183 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,24 @@ # playlist helper +## Usage + +```sh +pipx install pleb-saberlist +replay_ranked_ss +``` + +### Example + +```sh +replay_ranked_ss +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★): +``` + +Creates a playlist called `Replay SS 6.0★.bplist` + ## Development Clone the repo and install dependencies into a local virtual environment: diff --git a/pyproject.toml b/pyproject.toml index 241fd8d..0d37b83 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=65.5.0"] build-backend = "setuptools.build_meta" [project] -name = "saberlist" +name = "pleb-saberlist" version = "0.1.0" description = "Beat Saber playlist tool" readme = "README.md"