doc:补充配置说明和示例文档

.gitignore

@@ -1,8 +1,3 @@
 *.exe
-.vscode/launch.json
 plugins
-fortune
-configs
-jrrp
-bili-live.db
-.bot.env
+configs/onebot-plus.yaml

configs/README.md

@@ -1,2 +1,20 @@
 # configs
-项目示例配置文件
+配置文件读取路径为程序运行目录下的`configs`文件夹下的`onebot-plus.yaml`文件
+## onebot-plus.yaml
+```
+api: 
+# 调用go-cqhttp的api 配置
+  type: http 
+  #支持三种方式 http / websocket / websocket-reverse
+  endpoint: "http(s)://xxxxxxxx" 
+  # 当类型是websocket-reverse时，此项用于声明本服务gin的启动配置例如:`0.0.0.0:6700`或者 `127.0.0.1:6700`
+  accessToken: "_access_token"
+event:
+  type: "websocket" 
+  # websocket / websocket-reverse / http-reverse
+  addr: "ws(s)://xxxxxx" 
+  #当类型是websocket-reverse/http-reverse时，此项用于声明本服务gin的启动配置例如:`0.0.0.0:6700`或者 `127.0.0.1:6700`
+  accessToken: "_access_token"
+```
+## 注意事项
+如果是反向ws或者反向http，需要在go-cqhttp的配置文件中修改配置,用于连接到本服务

examples/README.md

@@ -1,2 +1,5 @@
 # examples
-示例文件
+示例文件
+- 执行` sh build.sh `生成可执行插件
+- 修改` main.go `中的插件路径
+- 执行` go run main.go `运行