diff --git a/README.MD b/README.MD index df8fa64..ae9245c 100644 --- a/README.MD +++ b/README.MD @@ -1,3 +1,15 @@ # surl -A simple URL shortener written in kotlin +短链接生成系统 +## 配置项 + +- 数据库类型: `POSTGRESQL` +- 缓存中间件: `REDIS` + +### 环境变量 + +- `DB_HOST`: 数据库主机, 必选 +- `DB_PORT`: 数据库主机端口, 可选 +- `DB_PASS`: 数据库密码, 必选 +- `REDIS_HOST`: `REDIS`主机, 必选 +- `SECRET`: `TOKEN`密钥, 可选