From 8651393f808deaf52460ccefc6101a2594a0a948 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=AE=B8=E6=9D=B0?= <1102043058@qq.com>
Date: Sat, 17 Jul 2021 13:54:06 +0000
Subject: [PATCH] add README.md.

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9734ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# node-rtsp-stream-server
+
+#### 介绍
+使用ffpemg推流的方式在H5中播放视频通道中的画面
+
+#### 软件架构
+软件架构说明
+
+
+#### 安装教程
+
+1.  git clone https://gitee.com/xskj001/node-rtsp-stream-server.git
+2.  npm i
+3.  npm run start
+
+#### 使用说明
+
+1.  服务端依赖 node-rtsp-stream
+    https://github.com/kyriesent/node-rtsp-stream
+2.  客户端依赖 jsmpeg 
+    https://github.com/phoboslab/jsmpeg
+
+   客户端演示，参照项目中的 index.html
+  
\ No newline at end of file