Merge branch 'pull/221' into master

[nhentai.git] / README.rst

diff --git a/README.rst b/README.rst
index e3367205b2378f913e562063f62dd334b5915e85..579861910222bafdf708d8a947f3f9c2241ab177 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -19,15 +19,30 @@ nhentai
 
 nHentai is a CLI tool for downloading doujinshi from <http://nhentai.net>
 
-============
-Installation
-============
+===================
+Manual Installation
+===================
 .. code-block::
 
     git clone https://github.com/RicterZ/nhentai
     cd nhentai
     python setup.py install
-    
+
+==================
+Installation (pip)
+==================
+Alternatively, install from PyPI with pip:
+
+.. code-block::
+
+           pip install nhentai
+
+For a self-contained installation, use `Pipx <https://github.com/pipxproject/pipx/>`_:
+
+.. code-block::
+
+           pipx install nhentai
+
 =====================
 Installation (Gentoo)
 =====================
@@ -50,6 +65,17 @@ Set your nhentai cookie against captcha:
 
     nhentai --cookie "YOUR COOKIE FROM nhentai.net"
 
+**NOTE**: The format of the cookie is `"csrftoken=TOKEN; sessionid=ID"`
+
+| To get csrftoken and sessionid, first login to your nhentai account in web browser, then:
+| (Chrome) |ve| |ld| More tools    |ld| Developer tools     |ld| Application |ld| Storage |ld| Cookies |ld| https://nhentai.net
+| (Firefox) |hv| |ld| Web Developer |ld| Web Developer Tools                  |ld| Storage |ld| Cookies |ld| https://nhentai.net
+| 
+
+.. |hv| unicode:: U+2630 .. https://www.compart.com/en/unicode/U+2630
+.. |ve| unicode:: U+22EE .. https://www.compart.com/en/unicode/U+22EE
+.. |ld| unicode:: U+2014 .. https://www.compart.com/en/unicode/U+2014
+
 Download specified doujinshi:
 
 .. code-block:: bash
@@ -62,53 +88,20 @@ Download doujinshi with ids specified in a file (doujinshi ids split by line):
 
     nhentai --file=doujinshi.txt
 
-Search a keyword and download the first page:
+Set search default language
 
 .. code-block:: bash
 
-    nhentai --search="tomori" --page=1 --download
-
-Download by tag name:
+    nhentai --language=english
 
-.. code-block:: bash
-
-    nhentai --tag lolicon --download --page=2
-
-Download by language:
-
-.. code-block:: bash
-
-    nhentai --language english --download --page=2
-
-Download by artist name:
-
-.. code-block:: bash
-
-    nhentai --artist henreader --download
-
-Download by character name:
-
-.. code-block:: bash
-
-    nhentai --character "kuro von einsbern" --download
-
-Download by parody name:
-
-.. code-block:: bash
-
-    nhentai --parody "the idolmaster" --download
-
-Download by group name:
-
-.. code-block:: bash
-
-    nhentai --group clesta --download
-
-Download using multiple tags (--tag, --character, --paordy and --group supported):
+Search a keyword and download the first page:
 
 .. code-block:: bash
 
-    nhentai --tag "lolicon, teasing" --artist "tamano kedama, atte nanakusa"
+    nhentai --search="tomori" --page=1 --download
+    # you also can download by tags and multiple keywords
+    nhentai --search="tag:lolicon, artist:henreader, tag:full color"
+    nhentai --search="lolicon, henreader, full color"
 
 Download your favorites with delay:
 
@@ -168,9 +161,11 @@ Other options:
       # Generating options
       --html                generate a html viewer at current directory
       --no-html             don't generate HTML after downloading
+      --gen-main            generate a main viewer contain all the doujin in the folder
       -C, --cbz             generate Comic Book CBZ File
+      -P --pdf              generate PDF file
       --rm-origin-dir       remove downloaded doujinshi dir when generated CBZ
-                            file.
+                            or PDF file.
 
       # nHentai options
       --cookie=COOKIE       set cookie of nhentai to bypass Google recaptcha
@@ -182,7 +177,7 @@ 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:
 
-.. code-block:: 
+.. code-block::
 
     i.h.loli.club -> i.nhentai.net
     h.loli.club -> nhentai.net