update README

This commit is contained in:
Ricter Z 2023-02-06 00:42:53 +08:00
parent c48a25bd4e
commit 5778d7a6e5

View File

@ -9,7 +9,7 @@ nhentai
|license| |license|
nHentai is a CLI tool for downloading doujinshi from <http://nhentai.net> nhentai is a CLI tool for downloading doujinshi from `nhentai.net <https://nhentai.net>`_
=================== ===================
Manual Installation Manual Installation
@ -22,7 +22,7 @@ From Github:
cd nhentai cd nhentai
python setup.py install python setup.py install
Use Docker: Build Docker container:
.. code-block:: .. code-block::
@ -32,38 +32,36 @@ Use Docker:
docker run -it -v ~/Downloads/doujinshi:/output -v ~/.nhentai/:/root/.nhentai nhentai --id 123855 docker run -it -v ~/Downloads/doujinshi:/output -v ~/.nhentai/:/root/.nhentai nhentai --id 123855
================== ==================
Installation (pip) Installation
================== ==================
Alternatively, install from PyPI with pip: From PyPI with pip:
.. code-block:: .. code-block::
pip install nhentai pip install nhentai
For a self-contained installation, use `Pipx <https://github.com/pipxproject/pipx/>`_: For a self-contained installation, use `pipx <https://github.com/pipxproject/pipx/>`_:
.. code-block:: .. code-block::
pipx install nhentai pipx install nhentai
From docker hub: Pull from Dockerhub:
.. code-block:: .. code-block::
docker pull ricterz/nhentai docker pull ricterz/nhentai
docker run -it -v ~/Downloads/doujinshi:/output -v ~/.nhentai/:/root/.nhentai ricterz/nhentai --id 123855 docker run -it -v ~/Downloads/doujinshi:/output -v ~/.nhentai/:/root/.nhentai ricterz/nhentai --id 123855
===================== On Gentoo Linux:
Installation (Gentoo)
=====================
.. code-block:: .. code-block::
layman -fa glicOne layman -fa glicOne
sudo emerge net-misc/nhentai sudo emerge net-misc/nhentai
===================== On NixOS:
Installation (NixOs)
=====================
.. code-block:: .. code-block::
nix-env -iA nixos.nhentai nix-env -iA nixos.nhentai
@ -73,17 +71,12 @@ Usage
===== =====
**⚠IMPORTANT⚠**: To bypass the nhentai frequency limit, you should use `--cookie` and `--useragent` options to store your cookie and your user-agent. **⚠IMPORTANT⚠**: To bypass the nhentai frequency limit, you should use `--cookie` and `--useragent` options to store your cookie and your user-agent.
*The default download folder will be the path where you run the command (CLI path).*
Set your nhentai cookie against captcha:
.. code-block:: bash .. code-block:: bash
nhentai --useragent "USER AGENT of YOUR BROWSER" nhentai --useragent "USER AGENT of YOUR BROWSER"
nhentai --cookie "YOUR COOKIE FROM nhentai.net" nhentai --cookie "YOUR COOKIE FROM nhentai.net"
**NOTE** **NOTE:**
- The format of the cookie is `"csrftoken=TOKEN; sessionid=ID; cf_clearance=CLOUDFLARE"` - The format of the cookie is `"csrftoken=TOKEN; sessionid=ID; cf_clearance=CLOUDFLARE"`
- `cf_clearance` cookie and useragent must be set if you encounter "blocked by cloudflare captcha" error. Make sure you use the same IP and useragent as when you got it - `cf_clearance` cookie and useragent must be set if you encounter "blocked by cloudflare captcha" error. Make sure you use the same IP and useragent as when you got it
@ -101,6 +94,8 @@ Set your nhentai cookie against captcha:
:alt: nhentai :alt: nhentai
:align: center :align: center
*The default download folder will be the path where you run the command (CLI path).*
Download specified doujinshi: Download specified doujinshi:
.. code-block:: bash .. code-block:: bash