From 6b82591ab91115c20f96200b3fc75d9dcd7544d2 Mon Sep 17 00:00:00 2001
From: banshan <dwdcth@163.com>
Date: Fri, 8 Apr 2022 22:43:37 +0800
Subject: [PATCH] Create README.md

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50b4db6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# plugin-snap
+I帧截图插件
+
+# 安装
+1. 修改 Monibuca 项目中的 main.go ，在 import 里添加 `_ "github.com/Monibuca/plugin-snap/v3"`
+2. 修改 config.toml 添加 `[Snap]`
+
+# 接口
+`/api/snap?stream=视频流&timeout=超时毫秒`  
+
+视频流即流列表中的StreamPath，timeout默认超时2500毫秒，可以不传