diff --git a/README.md b/README.md index a89cc0f..5ae06a5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,37 @@ -# yoink +# Yo!nk -[![wakatime](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink.svg)](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink) +[![wakatime](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink.svg)](https://wakatime.com/badge/gitlab/Rigil-Kent/yoink) [![Tests](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.svg)](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.sv) -[![Tests](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.svg)](https://github.com/Rigil-Kent/yoink/actions/workflows/tests.yml/badge.sv) +Yo!nk is a multi-site media download tool that scrapes comic images from online aggragate sites like [readallcomics.com](http://readallcomics.com) and [dragonballsupermanga.net](https://dragonballsupermanga.net/) compressing them into a ```.cbr``` archive. Magnet links support from ```tpb.party``` coming soon. -Yoink! is a multisite media download tool. It scrapes comics from online comic aggragate sites like ```readallcomics.com``` and ```dragonballsupermanga.net``` compressing them into a .cbr archive. Magnet links support from ```tpb.party``` coming soon. \ No newline at end of file +## Supported Sites + +| Name | URL | +|------|-----| +| readallcomics | [http://readallcomics.com](http://readallcomics.com) | +| dragonballsupermanga | [https://dragonballsupermanga.net/](https://dragonballsupermanga.net/) | +| mangadex | [https://www.mangadex.tv](https://www.mangadex.tv) | + +## Installing/Getting Started + +Navigate to the downloaded folder & install using pip + +```shell +pip install -e . +``` + +## Usage + +Downloaded archives will appear in ```$HOME/yoink/library/comics``` unless otherwise specified in a ```yoink.json``` config file. Yoink will look both in the root of the program folder or in ```$HOME/.config/yoink``` before defaulting to a preconfigured dict. + +### You can download a single comic issue + +```shell +yoink http://readallcomics.com/static-season-one-6-2022/ +``` + +### Or an entire series from a starting point + +```shell +yoink -s http://readallcomics.com/static-season-one-6-2022/ +``` diff --git a/static/comic.png b/static/comic.png new file mode 100644 index 0000000..6d7ca70 Binary files /dev/null and b/static/comic.png differ diff --git a/tox.ini b/tox.ini index 201f524..4a4367e 100644 --- a/tox.ini +++ b/tox.ini @@ -1,10 +1,12 @@ [tox] minversion = 3.8.0 -envlist = py38, py39 +envlist = py36, py37, py38, py39 isolated_build = true [gh-actions] python = + 3.6: py36 + 3.6: py37 3.8: py38 3.9: py39