Skip to content

Commit

Permalink
download script doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Egsagon authored Jun 22, 2023
1 parent 9919403 commit 15b7dc1
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,19 @@ pip install --upgrade phub
pip install --upgrade git+https://github.com/Egsagon/PHUB.git
```

## Usage
## CLI usage
You can use phub like so form the terminal to start a small downloading script:
(Assuming `py` represents your python executable, on linux use `python3`)
```sh
py -m phub --help
```

Example for downloading a video knowing its url, in the best available quality:
```sh
py -m phub --url https://... -q 'best'
````

## Package usage
Example video download usage:
```python
import phub
Expand Down

0 comments on commit 15b7dc1

Please sign in to comment.