diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..be07835
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,12 @@
+## 介绍
+此项目用 workspace 进行管理，各个模块都在对应 `package` 里面。
+
+各个代表 : 以 packages 为基本目录
+
+- `./gotify-ws` 为 `gotify` 的日志记录内容，保存的是其他人非法进入服务器 `ip` 内容， 保存到数据库里面
+
+- `./model` 为 `各个部分` 的数据库模型，下面子目录是各个部分的数据库模型
+
+- `./serv` 作为 ` http server `
+
+各个部分内部都有相应的测试文件，测试文件夹为 `test`
\ No newline at end of file