Update README.rst

This commit is contained in:
Ricter Zheng 2019-05-18 20:22:55 +08:00 committed by GitHub
parent 53c23bb6dc
commit 795f80752f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,6 +2,7 @@ nhentai
=======
.. code-block::
_ _ _ _
_ __ | | | | ___ _ __ | |_ __ _(_)
| '_ \| |_| |/ _ \ '_ \| __/ _` | |
@ -10,15 +11,16 @@ nhentai
あなたも変態。 いいね?
[![Build Status](https://travis-ci.org/RicterZ/nhentai.svg?branch=master)](https://travis-ci.org/RicterZ/nhentai) ![nhentai PyPI Downloads](https://img.shields.io/pypi/dm/nhentai.svg) [![license](https://img.shields.io/cocoapods/l/AFNetworking.svg)](https://github.com/RicterZ/nhentai/blob/master/LICENSE)
|travis|
|pypi|
|license|
[![license](https://img.shields.io/cocoapods/l/AFNetworking.svg)](https://github.com/RicterZ/nhentai/blob/master/LICENSE)
nHentai is a CLI tool for downloading doujinshi from [nhentai.net](http://nhentai.net).
============
Installation
============
.. code-block::
git clone https://github.com/RicterZ/nhentai
@ -28,7 +30,6 @@ Installation
=====================
Installation (Gentoo)
=====================
.. code-block::
layman -fa glicOne
@ -38,11 +39,15 @@ Installation (Gentoo)
Usage
=====
**IMPORTANT**: To bypass the nhentai frequency limit, you should use `--login` option to log into nhentai.net.
*The default download folder will be the path where you run the command (CLI path).*
Download specified doujinshi:
Set your nhentai cookie aginest captcha:
.. code-block:: bash
nhentai --cookie 'YOUR COOKIE FROM nhentai.net'
.. code-block:: bash
nhentai --id=123855,123866
@ -59,22 +64,21 @@ Search a keyword and download the first page:
nhentai --search="tomori" --page=1 --download
Download your favourite doujinshi (login required):
.. code-block:: bash
nhentai --login "username:password" --download
Download by tag name:
.. code-block:: bash
nhentai --tag lolicon --download
Download your favorites:
.. code-block:: bash
nhentai --favorites --download
=======
Options
=======
+ `-t, --thread`: Download threads, max: 10
+ `--output`:Output dir of saving doujinshi
+ `--tag`:Download by tag name
@ -87,7 +91,6 @@ Options
==============
nHentai Mirror
==============
If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.
For example:
@ -104,5 +107,17 @@ Set `NHENTAI` env var to your nhentai mirror.
![](./images/download.png)
![](./images/viewer.png)
### あなたも変態
===========
あなたも変態
===========
![](./images/image.jpg)
.. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master
:target: https://travis-ci.org/RicterZ/nhentai
.. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg
:target: https://pypi.org/project/nhentai/
.. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg
:target: https://github.com/RicterZ/nhentai/blob/master/LICENS