Skip to content

Commit

Permalink
docs: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sdaqo committed May 11, 2024
1 parent 9350915 commit 89d1607
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 9 deletions.
19 changes: 19 additions & 0 deletions docs/getting-started-api/index.md
Original file line number Diff line number Diff line change
@@ -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!

Expand Down
46 changes: 37 additions & 9 deletions docs/getting-started-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 89d1607

Please sign in to comment.