📝 更新文档

README.md

@@ -1,15 +1,15 @@
-## blivedm-go
+# blivedm-go
 
 bilibili 直播弹幕 golang 库
 
-### 安装
+## 安装
 ```shell
 go get github.com/Akegarasu/blivedm-go
 ```
 
-### 快速开始
+## 快速开始
 
-#### 基础使用
+### 基础使用
 
 该库支持以下几种基本事件，并且支持监听自定义事件。
 - 弹幕
@@ -22,9 +22,9 @@ go get github.com/Akegarasu/blivedm-go
 package main
 
 import (
-	"blivedm-go/client"
-	"blivedm-go/message"
 	"fmt"
+	"github.com/Akegarasu/blivedm-go/client"
+	"github.com/Akegarasu/blivedm-go/message"
 	"github.com/tidwall/gjson"
 )
 
@@ -46,6 +46,10 @@ func main() {
 	c.OnGuardBuy(func(guardBuy *message.GuardBuy) {
 		fmt.Printf("%v\n", guardBuy)
 	})
+	// 【可选】设置弹幕服务器，不设置就会从 api 获取服务器地址
+	// 该函数设置服务器为 wss://broadcastlv.chat.bilibili.com/sub
+	c.UseDefaultHost()
+	// 启动
 	err := c.ConnectAndStart()
 	if err != nil {
 		fmt.Println(err)
@@ -57,12 +61,30 @@ func main() {
 
 ```
 
-#### 进阶使用
+### 进阶使用
-通过自定义监听事件，可以支持更多事件处理。
+
+#### 监听自定义事件
+
+通过自定义监听事件，可以支持更多事件处理。  
+其中，`cmd`为要监听的`cmd`名（下附常见`cmd`名）， `handler`为接收事件消息（字符串的JSON）的函数
+```go
+func (c *Client) RegisterCustomEventHandler(cmd string, handler func(s string))
+```
 ```go
 // 监听自定义事件
-c.RegisterCustomEventHandler("PREPARE", func(s string) {
+c.RegisterCustomEventHandler("STOP_LIVE_ROOM_LIST", func(s string) {
-    cmd := gjson.Get(s, "cmd").String()
+    data := gjson.Get(s, "data").String()
-    fmt.Printf(cmd)
+    fmt.Printf(data)
 })
 ```
+
+### 常见 CMD
+注：来自blivedm
+```python
+cmd = (
+        'INTERACT_WORD', 'ROOM_BANNER', 'ROOM_REAL_TIME_MESSAGE_UPDATE', 'NOTICE_MSG', 'COMBO_SEND',
+        'COMBO_END', 'ENTRY_EFFECT', 'WELCOME_GUARD', 'WELCOME', 'ROOM_RANK', 'ACTIVITY_BANNER_UPDATE_V2',
+        'PANEL', 'SUPER_CHAT_MESSAGE_JPN', 'USER_TOAST_MSG', 'ROOM_BLOCK_MSG', 'LIVE', 'PREPARING',
+        'room_admin_entrance', 'ROOM_ADMINS', 'ROOM_CHANGE'
+    )
+```