update README.md

release
takayama-lily · Jul 22, 2021 · ec34ebf · ec34ebf
1 parent 6cd0fba
commit ec34ebf
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -4,17 +4,14 @@
 [![node engine](https://img.shields.io/node/v/oicq.svg)](https://nodejs.org)
 [![discord](https://img.shields.io/static/v1?label=chat&message=on%20discord&color=7289da&logo=discord)](https://discord.gg/gKnU7BARzv)
 
-* QQ(安卓)协议基于Node.js的实现，同时参考了 [mirai](https://github.com/mamoe/mirai) 等优秀开源项目
-* 使用CQHTTP风格的API，原生支持经典CQ码，代替死去的酷Q
+* QQ(安卓)协议基于Node.js的实现，使用CQHTTP风格的API，原生支持CQ码
 * 已实现大部分常用功能，支持最低node版本为 v12.16
-* [awesome](./awesome.md) 社区相关应用收集。
 
 ----
 
 **Install:**
 
 ```bash
-> npm init    # or > yarn init
 > npm i oicq  # or > yarn add oicq
 ```
 
@@ -31,17 +28,40 @@ client.on("system.online", () => console.log("Logged in!"));
 //监听消息并回复
 client.on("message", (data) => data.reply("hello world"));
 
-//监听滑动验证码事件并输入ticket
-client.on("system.login.slider", function () {
+/****************************************
+ * 手机QQ扫描二维码登录，与下面的传统密码登录二选一
+ * 优点是不需要过滑块和设备锁
+ * 缺点是万一token失效需要重新扫码验证
+ */
+client.on("system.login.qrcode", function (data) {
+  console.log(data)
+  process.stdin.once("data", () => {
+    this.login(); //扫码后按回车登录
+  });
+});
+client.login(); //这里不填写密码
+
+/****************************************
+ * 传统密码登录
+ * 缺点是需要过滑块，可能会报环境异常
+ * 优点是一劳永逸
+ */
+client.on("system.login.slider", function (data) { //监听滑动验证码事件
+  console.log(data)
   process.stdin.once("data", (input) => {
-    this.sliderLogin(input);
+    this.sliderLogin(input); //输入ticket
   });
 });
-
-client.login("password"); // your password or password_md5
+client.on("system.login.device", function (data) { //监听登录保护验证事件
+  console.log(data)
+  process.stdin.once("data", () => {
+    this.login(); //验证完成后按回车登录
+  });
+});
+client.login("password"); //需要填写密码或md5后的密码
 ```
 
-**常用功能一瞥：**
+**常用功能：**
 
 ```js
 client.sendGroupMsg(gid, "hello") //群聊
@@ -62,6 +82,7 @@ client.setGroupBan(gid, uid, 3600) //禁言
 [常见问题](https://github.com/takayama-lily/oicq/wiki/02.%E5%85%B6%E4%BB%96%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)  
 [关于封号和风控](https://github.com/takayama-lily/oicq/wiki/98.%E5%85%B3%E4%BA%8E%E8%B4%A6%E5%8F%B7%E5%86%BB%E7%BB%93%E5%92%8C%E9%A3%8E%E6%8E%A7)  
 [wiki列表](https://github.com/takayama-lily/oicq/wiki)  
+[awesome](./awesome.md) 社区相关应用收集
 
 **其他：**
 

diff --git a/docs/api.md b/docs/api.md
diff --git a/docs/demo.js b/docs/demo.js
@@ -12,14 +12,21 @@ const bot = createClient(uin, {
     platform: 5, //登录设备选择为iPad
 });
 
-//监听并输入滑动验证码ticket(同一设备只需验证一次)
+//走扫码登录
+bot.on("system.login.qrcode", () => {
+    process.stdin.once("data", () => {
+        bot.login();
+    });
+});
+
+//走密码登录，监听并输入滑动验证码ticket(同一设备只需验证一次)
 bot.on("system.login.slider", () => {
     process.stdin.once("data", (input) => {
         bot.sliderLogin(input);
     });
 });
 
-//监听设备锁验证(同一设备只需验证一次)
+//走密码登录，监听设备锁验证(同一设备只需验证一次)
 bot.on("system.login.device", () => {
     bot.logger.info("验证完成后敲击Enter继续..");
     process.stdin.once("data", () => {
@@ -60,7 +67,7 @@ bot.on("notice.group.increase", (data) => {
 });
 
 // login with your password or password_md5
-bot.login("password");
+bot.login("password"); //不输入密码则走扫码登录
 
 //同一事件可以多次监听
 //更多api和事件请参考文档或index.d.ts文件
diff --git a/docs/event.md b/docs/event.md
diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
   "name": "oicq",
   "app_name": "oicq",
-  "version": "1.17.3",
-  "app_version": "1.17.3",
-  "upday": "2021/6/6",
+  "version": "1.18.0",
+  "app_version": "1.18.0",
+  "upday": "2021/7/22",
   "protocol_version": "v11",
   "description": "QQ protocol!",
   "main": "index.js",