From 031fc198e690b9193060477a6d11868307787d0b Mon Sep 17 00:00:00 2001
From: "Anthony.Liu" <anthony.liu@wiwide.com>
Date: Wed, 15 Mar 2023 21:38:40 +0800
Subject: [PATCH] README.MD

---
 README.MD | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.MD

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..2923803
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,35 @@
+# HTTP鉴权插件
+
+用于对推流和拉流客户端进行鉴权
+
+## 插件地址
+
+https://github.com/haowanxing/plugin-http-auth
+
+## 插件引入
+
+```go
+import (
+    _ "github.com/haowanxing/plugin-http-auth"
+)
+```
+
+## 配置
+
+```yaml
+httpauth:
+  onsubaddr: http://localhost:9091/subauth
+  onpubaddr: http://localhost:9091/pubauth
+```
+
+## API回调请求
+
+```json
+{
+    "action": "subscribe/publish",
+    "app": "live",
+    "stream": "test",
+    "param": "field1=value1&field2=value2",
+    "client_id": "127.0.0.1:53779"
+}
+```
\ No newline at end of file