diff --git a/docs/getting-started-api/index.md b/docs/getting-started-api/index.md index e6d886a9..0a47b6aa 100644 --- a/docs/getting-started-api/index.md +++ b/docs/getting-started-api/index.md @@ -1,5 +1,24 @@ # Getting started with the API +## Installation +- Via poetry: +``` +poetry add anipy-cli +``` +- Via poetry (from source): +``` +poetry add "git+https://github.com/sdaqo/anipy-cli.git#subdirectory=api" +``` +- Via pip: +``` +pip install anipy-cli +``` +- Via pip (from source): +``` +pip install "git+https://github.com/sdaqo/anipy-cli.git#subdirectory=api" +``` + + ## Introduction If you do not want to see examples and dive directly into the api, please go to the [Code Reference](../reference/index.md) you will find everything you need there, even stuff not covered in the examples! diff --git a/docs/getting-started-cli/index.md b/docs/getting-started-cli/index.md index 20fb1b2e..02208808 100644 --- a/docs/getting-started-cli/index.md +++ b/docs/getting-started-cli/index.md @@ -12,20 +12,48 @@ ### Options to install - **Recommended: Via pipx** ``` + # Install pipx install anipy-cli + + # Update + pipx upgrade anipy-cli + + # Uninstall + pipx uninstall anipy-cli ``` - Via pipx (from source): - ``` - pipx install "git+https://github.com/sdaqo/anipy-cli.git@api_rewrite#subdirectory=cli" - ``` +``` +# Install +pipx install "git+https://github.com/sdaqo/anipy-cli.git#subdirectory=cli" + +# Update +pipx upgrade anipy-cli + +# Uninstall +pipx uninstall anipy-cli +``` - Via pip: - ``` - pip install anipy-cli - ``` +``` +# Install +pip install anipy-cli + +# Update +pip --upgrade anipy-cli + +# Uninstall +pip uninstall anipy-cli +``` - Via pip (from source): - ``` - pip install "git+https://github.com/sdaqo/anipy-cli.git@api_rewrite#subdirectory=cli" - ``` +``` +# Install +pip install "git+https://github.com/sdaqo/anipy-cli.git#subdirectory=cli" + +# Update +pip --upgrade anipy-cli + +# Uninstall +pip uninstall anipy-cli +``` - AUR: Coming Soon™ ## Usage