]> git.lizzy.rs Git - nhentai.git/commitdiff
Update README.md
authorRicter Zheng <RicterZheng@gmail.com>
Sat, 11 Aug 2018 01:45:04 +0000 (09:45 +0800)
committerGitHub <noreply@github.com>
Sat, 11 Aug 2018 01:45:04 +0000 (09:45 +0800)
README.md

index 6b348f7e7d2f6b26382100c7eb1be5e23b9347b7..b57c6ab9fd6ae97cfcd71df2cfe63493c410f658 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,11 +7,10 @@ nhentai
     |_| |_|_| |_|\___|_| |_|\__\__,_|_|\r
 \r
 あなたも変態。 いいね?  \r
-[![Build Status](https://travis-ci.org/RicterZ/nhentai.svg?branch=master)](https://travis-ci.org/RicterZ/nhentai)  \r
+![Build Status](https://travis-ci.org/RicterZ/nhentai.svg?branch=master)](https://travis-ci.org/RicterZ/nhentai) ![Download Status](https://pypistats.com/badge/nhentai.png)\r
 \r
-🎉🎉 nhentai 现在支持 Windows 啦!\r
 \r
-由于 [http://nhentai.net](http://nhentai.net) 下载下来的种子速度很慢,而且官方也提供在线观看本子的功能,所以可以利用本脚本下载本子。\r
+Nhentai is a CLI tool for downloading doujinshi from nhentai.net.\r
 \r
 ### Installation\r
 \r
@@ -25,36 +24,39 @@ nhentai
     sudo emerge net-misc/nhentai\r
 \r
 ### Usage\r
-下载指定 id 列表的本子:\r
+Download specified doujinshi:\r
 ```bash\r
 nhentai --id=123855,123866\r
 ```\r
 \r
-下载某关键词第一页的本子:\r
+Search a keyword and download the first page:\r
 ```bash\r
 nhentai --search="tomori" --page=1 --download\r
 ```\r
 \r
-下载用户 favorites 内容:\r
+Download your favourite doujinshi (login required):\r
 ```bash\r
 nhentai --login "username:password" --download\r
 ```\r
 \r
 ### Options\r
 \r
-`-t, --thread`:指定下载的线程数,最多为 10 线程。  \r
-`--path`:指定下载文件的输出路径,默认为当前目录。  \r
-`--timeout`:指定下载图片的超时时间,默认为 30 秒。  \r
-`--proxy`:指定下载的代理,例如: http://127.0.0.1:8080/\r
-`--login`:nhentai 账号的“用户名:密码”组合\r
-`--nohtml`:nhentai Don't generate HTML\r
-`--cbz`:nhentai Generate Comic Book CBZ file\r
+`-t, --thread`: Download threads, max: 10\r
+`--output`:Output dir of saving doujinshi\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
-如果想用自建镜像下载 nhentai 的本子,需要搭建 nhentai.net 和 i.nhentai.net 的反向代理。  \r
-例如用 h.loli.club 来做反向代理的话,需要 h.loli.club 反代 nhentai.net,i.h.loli.club 反带 i.nhentai.net。  \r
-然后利用环境变量来下载:  \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
@@ -67,4 +69,4 @@ NHENTAI=http://h.loli.club nhentai --id 123456
 MIT\r
 \r
 ### あなたも変態\r
-![](./images/image.jpg)
\ No newline at end of file
+![](./images/image.jpg)\r