Made the readme a little more fancy (#171)
Nex
Vishnunarayan K I
parent
f37278fd1f
commit
393a1f74ad
65
README.md
65
README.md
|
|
@ -1,13 +1,30 @@
|
|||
<div align="center">
|
||||
<img src="https://cdn.discordapp.com/attachments/484717445538643979/564476620401016862/Banner.png">
|
||||
<br>
|
||||
<strong><i>A simple yet powerful tool for downloading anime.</i></strong>
|
||||
<br>
|
||||
<br>
|
||||
<a href="https://travis-ci.com/vn-ki/anime-downloader">
|
||||
<img src="https://img.shields.io/travis/com/vn-ki/anime-downloader.svg?style=popout-square&logo=Travis%20CI">
|
||||
</a>
|
||||
<a href="https://codecov.io/gh/vn-ki/anime-downloader">
|
||||
<img src="https://img.shields.io/codecov/c/github/vn-ki/anime-downloader.svg?logo=codecov&style=popout-square">
|
||||
</a>
|
||||
<a href="https://pypi.org/project/anime-downloader/">
|
||||
<img src="https://img.shields.io/badge/Python-3.3%2B-lightblue.svg?style=popout-square&logo=python">
|
||||
</a>
|
||||
<a href="https://pypi.org/project/anime-downloader/">
|
||||
<img src="https://img.shields.io/pypi/v/anime-downloader.svg?color=lightblue&logo=python&style=popout-square">
|
||||
</a>
|
||||
<a href="https://discord.gg/Qn2nWGm">
|
||||
<img src="https://img.shields.io/discord/483008720167632929.svg?color=%237289DA&label=Discord&logo=Discord&style=popout-square">
|
||||
</a>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
# Anime Downloader
|
||||
|
||||
[](https://travis-ci.com/vn-ki/anime-downloader)
|
||||
[](https://codecov.io/gh/vn-ki/anime-downloader)
|
||||
[](https://pypi.org/project/anime-downloader/)
|
||||
[](https://pypi.org/project/anime-downloader/)
|
||||
[](https://discord.gg/Qn2nWGm)
|
||||
|
||||
<!-- #### NOTE: **9anime support has been experiencing issues for the past week. It might work but not 100% reliable. Kissanime still works as expected.** -->
|
||||
|
||||
Ever dreamt about watching anime for free effortlessly without all those unbearable ads? Ever dreamt of downloading your favourite anime for that long trip?
|
||||
|
||||
|
||||
|
|
@ -22,8 +39,8 @@ Yeah. Me too! That's why this tool exists.
|
|||
- Save yourselves from those malicious ads.
|
||||
- Add any anime to your watch list using `anime watch` and let anime downloader take care of everything for you.
|
||||
- Download using external downloader ([aria2](https://aria2.github.io/) recommended).
|
||||
- Configurable using `config.json`. See [doc](https://github.com/vn-ki/anime-downloader/wiki/Config).
|
||||
|
||||
- Configurable using `config.json`. See [documentation](https://github.com/vn-ki/anime-downloader/wiki/Config).
|
||||
|
||||
## Supported Sites
|
||||
|
||||
<!-- [](https://circleci.com/gh/vn-ki/anime-downloader/tree/master) -->
|
||||
|
|
@ -36,21 +53,21 @@ Yeah. Me too! That's why this tool exists.
|
|||
- Gogoanime
|
||||
- AnimePahe [cloudflare]
|
||||
|
||||
NOTE: To download from sites marked `[cloudflare]`, anime-downloader has to be installed with cloudflare support(See below).
|
||||
**Note:** To download from sites marked [cloudflare], anime-downloader has to be installed with cloudflare support (see below).
|
||||
|
||||
## Installation
|
||||
|
||||
You can install the stable release from PyPI.
|
||||
You can install the stable release from PyPI:
|
||||
```bash
|
||||
$ pip install anime-downloader
|
||||
```
|
||||
|
||||
To install with cloudflare support, (Read note below)
|
||||
To install with cloudflare support (read note below):
|
||||
```bash
|
||||
$ pip install anime-downloader[cloudflare]
|
||||
```
|
||||
|
||||
To install the dev version
|
||||
To install the dev version:
|
||||
```bash
|
||||
$ pip install -U git+https://github.com/vn-ki/anime-downloader.git
|
||||
|
||||
|
|
@ -58,35 +75,31 @@ $ pip install -U git+https://github.com/vn-ki/anime-downloader.git
|
|||
$ pip install -U git+https://github.com/vn-ki/anime-downloader.git#egg=anime-downloader[cloudflare]
|
||||
```
|
||||
|
||||
If you have trouble installing, see extended installation instructions [here](https://github.com/vn-ki/anime-downloader/wiki/Installation).
|
||||
If you have trouble installing, see extended installation instructions [here](https://github.com/vn-ki/anime-downloader/wiki/Installation) or join the [discord server](https://discord.gg/Qn2nWGm) for help.
|
||||
|
||||
**NOTE**:
|
||||
**Note**:
|
||||
- For cloudflare scraping [cfscrape](https://github.com/Anorov/cloudflare-scrape) is used. It depends on [`node-js`](https://nodejs.org/en/). So if you want to use cloudflare, make sure you have [node-js](https://nodejs.org/en/) installed.
|
||||
- You might have to use pip3 depending on your system
|
||||
- If you are using zsh, don't forget to escape `[` and `]` using `\`.
|
||||
|
||||
## Usage
|
||||
## Usage
|
||||
|
||||
See [wiki](https://github.com/vn-ki/anime-downloader/wiki).
|
||||
See [wiki](https://github.com/vn-ki/anime-downloader/wiki).
|
||||
|
||||
Anime downloader has two sub commands, `dl` and `watch`.
|
||||
|
||||
- [dl](https://github.com/vn-ki/anime-downloader/wiki/dl-command): `dl` can download anime.
|
||||
- [watch](https://github.com/vn-ki/anime-downloader/wiki/watch-command): `watch` can manage your anime watch list. Needs [mpv](https://mpv.io). With `watch` you'll never have to go to any anime sites ever again.
|
||||
|
||||
### To use `anime_downloader` in your package
|
||||
**To use `anime_downloader` in your package:**
|
||||
|
||||
This tool can be used as a library. This means you can import it into your own application and search for anime and do many other wonderful things.
|
||||
See [documentation](https://github.com/vn-ki/anime-downloader/wiki/Package-documentation).
|
||||
|
||||
### Development Instructions
|
||||
**Development Instructions:**
|
||||
|
||||
See [development instructions](https://github.com/vn-ki/anime-downloader/wiki/Development-Instructions)
|
||||
See [development instructions](https://github.com/vn-ki/anime-downloader/wiki/Development-Instructions).
|
||||
|
||||
---
|
||||
|
||||
*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**
|
||||
|
||||
|
||||
*Please don't judge me for not paying for anime. I want to support the anime industry, but being a college student, I can't.*
|
||||
|
|
|
|||
Loading…
Reference in New Issue