From 551611241895b9a57206cf898a275b7974011fc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mike=20F=C3=A4hrmann?= Date: Tue, 10 Nov 2015 21:13:43 +0100 Subject: [PATCH] update README --- README.rst | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 1f679288..8befb279 100644 --- a/README.rst +++ b/README.rst @@ -2,18 +2,18 @@ gallery-dl ========== -gallery-dl is a image gallery downloader for several image hosting platforms. +*gallery-dl* is a small command-line tool to download images and entire image galleries from several image hosting platforms. Installation ------------- +============ -Via pip: +You can install *gallery-dl* with pip: .. code:: bash $ pip install gallery-dl -Or from github: +or directly from github: .. code:: bash @@ -21,19 +21,30 @@ Or from github: $ cd gallery-dl $ python3 setup.py install +Supported Sites +=============== + +* images (and ugoira) per artist from pixiv, nijie, deviantart +* images per tag from booru-like sites (danbooru, gelbooru, chan.sankakucomplex, yandere, konachan, safebooru, 3dbooru, e621) +* manga chapters from batoto, kissmanga, mangapanda, mangareader, mangastream, powermanga, redhawkscans +* galleries from exhentai, nhentai, hitomi +* images and videos from threads on Futaba Channel-like boards (4chan, 8chan) + Usage ------ +===== .. code:: bash $ gallery-dl URL [URL...] +Certain supported sites require authentication to download images from. This currently includes pixiv, exhentai, gelbooru and nijie. To make these sites accessible to *gallery-dl* you need to specify the necessary login credentials or cookies in the configuration files. + Configuration -------------- +============= Configuration files for gallery-dl use a JSON-based file format. For a (more or less) complete example, see gallery-dl.conf_. -gallery-dl searches for configuration files in the following paths: +*gallery-dl* searches for configuration files in the following paths: * /etc/gallery-dl.conf * ~/.config/gallery/config.json