commit 52c4cd8a94af4fb7335c8a1c72a07d7c9bafcd4f
Author: yanqs <git@yanqingshan.com>
Date:   Sun Mar 24 19:48:44 2024 +0800

    初始化项目并发布1.0.0版本

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53e565a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# Mi-Wifi-Agent 服务
+
+## 简介
+小米/红米路由器基于官方固件API接口实现的第三方管理服务。
+
+## 效果展示
+
+![登录页](./doc/images/1.png)
+
+![首页状态](./doc/images/2.png)
+
+![端口转发](./doc/images/3.png)
+
+## 对接计划
+
+- [x] 系统鉴权
+- [x] 路由器状态
+- [x] 端口转发
+- [x] 设备列表
+- [x] 前端界面
+
+## Docker部署
+
+```bash
+docker pull registry.cn-hangzhou.aliyuncs.com/bcrjl/miwifi-agent:latest
+
+docker run -d --name miwifi-agent \
+--restart always \
+-p 24317:24317 \
+-e BMW_URL=192.168.31.1 \
+-e BMW_PASSWORD=123456 \
+-e WEB_PASSWORD=123456 \
+miwifi-agent:latest
+```
+
+`BMW_URL` 指路由器IP地址
+
+`BMW_PASSWORD` 指路由器密码
+
+`WEB_PASSWORD` 平台设置的密码
+
+运行成功后访问 `http://[IP]:24317`
+
+## 版本计划
+
+### 1.0.0
+
+- 项目初始化搭建；
+- 系统状态对接；
+- 端口映射对接；
+- 搭建前端页面；
diff --git a/doc/images/1.png b/doc/images/1.png
new file mode 100644
index 0000000..8618ff1
Binary files /dev/null and b/doc/images/1.png differ
diff --git a/doc/images/2.png b/doc/images/2.png
new file mode 100644
index 0000000..c6fff90
Binary files /dev/null and b/doc/images/2.png differ
diff --git a/doc/images/3.png b/doc/images/3.png
new file mode 100644
index 0000000..9a98170
Binary files /dev/null and b/doc/images/3.png differ