Update README.md
parent
d4470f0bb7
commit
4db6c0f01c
36
README.md
36
README.md
|
@ -11,6 +11,13 @@ Ever dreamt about watching anime for free effortlessly without all those unbeara
|
|||
|
||||
Yeah. Me too! That's why this tool exists.
|
||||
|
||||
## Features
|
||||
|
||||
- Download or stream any episode or episode range of any anime.
|
||||
- Specify the quality you want to stream or download.
|
||||
- Search available if don't want to copy the url.
|
||||
- Save yourselves from those malicious ads.
|
||||
|
||||
## Installation
|
||||
|
||||
You can install the stable release from PyPI.
|
||||
|
@ -26,15 +33,15 @@ $ pip install -U git+https://github.com/vn-ki/anime-downloader.git
|
|||
|
||||
## Usage
|
||||
|
||||
Run `anime-dl --help` for help text.
|
||||
Anime downloader has two sub commands, `dl` and `watch`. `watch` does nothing currently (but it does, it will be awesome!).
|
||||
|
||||
Run `anime dl --help` for help text on `dl` subcommand.
|
||||
|
||||
```
|
||||
$ anime-dl --help
|
||||
Usage: anime-dl [OPTIONS] ANIME_URL
|
||||
$ anime dl --help
|
||||
Usage: anime dl [OPTIONS] ANIME_URL
|
||||
|
||||
Anime Downloader
|
||||
|
||||
Download your favourite anime.
|
||||
Download the anime using the url or search for it.
|
||||
|
||||
Options:
|
||||
-e, --episodes <int>:<int> Range of anime you want to download in the
|
||||
|
@ -45,6 +52,7 @@ Options:
|
|||
instead of downloading
|
||||
--play PLAYER Streams in the specified player
|
||||
--no-download Retrieve without downloading
|
||||
--download-dir TEXT Specifiy the directory to download to
|
||||
-q, --quality [360p|480p|720p] Specify the quality of episode. Default-720p
|
||||
-f, --force Force downloads even if file exists
|
||||
-ll, --log-level [DEBUG|INFO|WARNING|ERROR]
|
||||
|
@ -58,34 +66,34 @@ You can use this tool to search and download or download directly from the url.
|
|||
|
||||
- To search and download all episodes.
|
||||
```bash
|
||||
anime-dl 'code geass'
|
||||
anime dl 'code geass'
|
||||
```
|
||||
*NOTE: The above command shows the search results (which would fit you're terminal size :innocent:) and you can select the desired result.*
|
||||
|
||||
#### Download directly
|
||||
- To download Fullmetal Alchemist: Brotherhood all episodes
|
||||
```
|
||||
anime-dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93'
|
||||
anime dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93'
|
||||
```
|
||||
|
||||
- To download Fullmetal Alchemist: Brotherhood episode 1
|
||||
```
|
||||
anime-dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --episodes 1
|
||||
anime dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --episodes 1
|
||||
```
|
||||
|
||||
- To download Fullmetal Alchemist: Brotherhood episode 1 to 20
|
||||
```
|
||||
anime-dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --episodes 1:21
|
||||
anime dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --episodes 1:21
|
||||
```
|
||||
|
||||
- To get stream url of Fullmetal Alchemist: Brotherhood episode 1.
|
||||
```
|
||||
anime-dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --url --episodes 1
|
||||
anime dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --url --episodes 1
|
||||
```
|
||||
|
||||
- To play using vlc. (On windows use path to exe)
|
||||
```
|
||||
anime-dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --play vlc --episodes 1
|
||||
anime dl 'https://9anime.is/watch/fullmetal-alchemist-brotherhood.0r7/j69y93' --play vlc --episodes 1
|
||||
```
|
||||
|
||||
### To use `anime_downloader` in your package
|
||||
|
@ -108,8 +116,8 @@ $ pip install -e .
|
|||
|
||||
- Support for more sites
|
||||
|
||||
*Don't judge me for not paying for anime. I want to support these animation studios, but being a college student, I can't.*
|
||||
*Please don't judge me for not paying for anime. I want to support these animation studios, but being a college student, I can't.*
|
||||
|
||||
**arigatou gozaimasu**
|
||||
|
||||
![arigato](https://media.giphy.com/media/VUC9YdLSnKuJy/giphy.gif)
|
||||
![arigatou](https://media.giphy.com/media/VUC9YdLSnKuJy/giphy.gif)
|
||||
|
|
Loading…
Reference in New Issue