update README

README.md

@@ -1,14 +1,48 @@
 # ShiguReader
 
+通过Chrome或者iPad轻松阅读本地漫画。
+
+##### Screenshot
+
+![screenshot-01](screenshot/01.png)
+![screenshot-02](screenshot/02.png)
+![screenshot-03](screenshot/03.png)
+
+
 ##### 怎么运行？
 参考 Env_README.md
 
+##### Quick Start
+
+```bash
+# Clone the repository
+git clone https://github.com/hjyssg/ShiguReader
+
+# Go inside the directory
+cd ShiguReader
+
+## change user config
+手动修改user-config.js用户文件设置  
+
+# Install dependencies
+yarn (or npm install)
+
+# Start development server
+yarn dev (or npm run dev)
+```
+
+##### clean local cache 定期手动清理解压缩漫画
+```bash
+npm run clean-cache
+```
+
 ##### 注意事项
 windows语言设置要参考unicode setting.png  
 user-config.js修改用户文件设置  
 
-一次性生成thumbnail 需要很多时间和硬盘容量  http://localhost:8080/api/pregenerateThumbnails  
-30分钟大约10,000个thumbnail
+##### 提前生成thumbnail
+http://localhost:8080/api/pregenerateThumbnails  
+30分钟大约生成10,000个thumbnail
 
 ##### 联系方式
 qq 398355565

src/user-config.js

@@ -1,14 +1,23 @@
 'use strict';
 
+/**
+ * OPTIONAL cache folder name
+ */
 module.exports.cache_folder_name = "cache";
 
 /**
- * Where ShiguReader will scan files 
+ * MUST Where ShiguReader will scan files 修改成本地存放漫画zip的路径
  */
 module.exports.home_pathes = ["T:\\迅雷下载", "D:\\_Happy_Lesson", "D:\\_Happy_Lesson\\_Unread", "D:\\_Happy_Lesson\\_Going_to_sort"];
 
+/** 
+ * OPTIONAL where to move file
+ */
 module.exports.good_folder = "D:\\_Happy_Lesson\\_Going_to_sort\\good_2019_02_01";
 
+/**
+ * OPTIONAL where to move file
+ */
 module.exports.not_good_folder = "D:\\_Happy_Lesson\\_Going_to_sort\\_Compressed_3";