0.2.15

[nhentai.git] / README.md

diff --git a/README.md b/README.md
index 788115ac9adeaa2cf33d4e133efa68983433e801..d016e1327dcaadd5a05cdc18d4198c9329655889 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,61 +1,78 @@
-nhentai
-=======
-           _   _            _        _
-     _ __ | | | | ___ _ __ | |_ __ _(_)
-    | '_ \| |_| |/ _ \ '_ \| __/ _` | |
-    | | | |  _  |  __/ | | | || (_| | |
-    |_| |_|_| |_|\___|_| |_|\__\__,_|_|
-
-あなたも変態。 いいね?  
-[![Build Status](https://travis-ci.org/RicterZ/nhentai.svg?branch=master)](https://travis-ci.org/RicterZ/nhentai)  
-
-🎉🎉 nhentai 现在支持 Windows 啦！
-
-由于 [http://nhentai.net](http://nhentai.net) 下载下来的种子速度很慢，而且官方也提供在线观看本子的功能，所以可以利用本脚本下载本子。
-### 安装
-
-    git clone https://github.com/RicterZ/nhentai
-    cd nhentai
-    python setup.py install
-    
-### Gentoo
-
-    layman -fa glicOne
-    sudo emerge net-misc/nhentai
-    
-
-### 用法
-+ 下载指定 id 列表的本子：
-
-
-    nhentai --id=123855,123866
-    
-
-+ 下载某关键词第一页的本子（不推荐）：
-
-
-    nhentai --search="tomori" --page=1 --download
-
-
-`-t, --thread`：指定下载的线程数，最多为 10 线程。  
-`--path`：指定下载文件的输出路径，默认为当前目录。  
-`--timeout`：指定下载图片的超时时间，默认为 30 秒。  
-`--proxy`：指定下载的代理，例如: http://127.0.0.1:8080/
-
-### 自建 nhentai 镜像
-如果想用自建镜像下载 nhentai 的本子，需要搭建 nhentai.net 和 i.nhentai.net 的反向代理。  
-例如用 h.loli.club 来做反向代理的话，需要 h.loli.club 反代 nhentai.net，i.h.loli.club 反带 i.nhentai.net。  
-然后利用环境变量来下载：  
-
-    NHENTAI=http://h.loli.club nhentai --id 123456
-
-
-![](./images/search.png)  
-![](./images/download.png)  
-![](./images/viewer.png)  
-
-### License  
-MIT
-
-### あなたも変態
-![](./images/image.jpg)
+nhentai\r
+=======\r
+           _   _            _        _\r
+     _ __ | | | | ___ _ __ | |_ __ _(_)\r
+    | '_ \| |_| |/ _ \ '_ \| __/ _` | |\r
+    | | | |  _  |  __/ | | | || (_| | |\r
+    |_| |_|_| |_|\___|_| |_|\__\__,_|_|\r
+\r
+あなたも変態。 いいね?  \r
+[![Build Status](https://travis-ci.org/RicterZ/nhentai.svg?branch=master)](https://travis-ci.org/RicterZ/nhentai) ![nhentai PyPI Downloads](https://pypistats.com/badge/nhentai.svg)  \r
+\r
+\r
+nHentai is a CLI tool for downloading doujinshi from [nhentai.net](http://nhentai.net).\r
+\r
+### Installation\r
+\r
+    git clone https://github.com/RicterZ/nhentai\r
+    cd nhentai\r
+    python setup.py install\r
+    \r
+### Gentoo\r
+\r
+    layman -fa glicOne\r
+    sudo emerge net-misc/nhentai\r
+\r
+### Usage\r
+Download specified doujinshi:\r
+```bash\r
+nhentai --id=123855,123866\r
+```\r
+\r
+Search a keyword and download the first page:\r
+```bash\r
+nhentai --search="tomori" --page=1 --download\r
+```\r
+\r
+Download your favourite doujinshi (login required):\r
+```bash\r
+nhentai --login "username:password" --download\r
+```\r
+\r
+Download by tag name:\r
+```bash\r
+nhentai --tag lolicon --download\r
+```\r
+\r
+### Options\r
+\r
++ `-t, --thread`: Download threads, max: 10  \r
++ `--output`:Output dir of saving doujinshi  \r
++ `--tag`:Download by tag name  \r
++ `--timeout`: Timeout of downloading each image   \r
++ `--proxy`: Use proxy, example: http://127.0.0.1:8080/  \r
++ `--login`: username:password pair of your nhentai account  \r
++ `--nohtml`: Do not generate HTML  \r
++ `--cbz`: Generate Comic Book CBZ File  \r
+\r
+### nHentai Mirror\r
+If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.\r
+For example:\r
+\r
+    i.h.loli.club -> i.nhentai.net\r
+    h.loli.club -> nhentai.net\r
+\r
+Set `NHENTAI` env var to your nhentai mirror.\r
+```bash\r
+NHENTAI=http://h.loli.club nhentai --id 123456\r
+```\r
+\r
+![](./images/search.png)  \r
+![](./images/download.png)  \r
+![](./images/viewer.png)  \r
+\r
+### License  \r
+MIT\r
+\r
+### あなたも変態\r
+![](./images/image.jpg)\r