Update README.md with project overview, features, environment variables, routing, and startup instructions

Author: lovebai

README.md

@@ -1 +1,42 @@
 # plist
+
+## 项目简介
+
+`plist` 是一个基于 Go 的在线图片分类展示工具，支持静态和动态加载图片，提供简单的认证功能。
+
+## 功能特性
+
+- **图片分类展示**：支持按目录分类展示图片。
+- **动态加载**：支持动态加载分类和图片，提升用户体验。
+- **认证功能**：通过密码保护访问，未认证用户需登录。
+- **分页支持**：分类和图片支持分页加载。
+- **自定义配置**：通过环境变量自定义站点配置。
+
+## 环境变量配置
+
+以下环境变量可用于自定义站点配置：
+
+- `SITE_DIR`：图片目录路径（默认值：`./`images）。
+- `SITE_PASSWORD`：访问密码（默认值：空）。
+- `SITE_PORT`：服务端口（默认值：`8008`）。
+- `SITE_TITLE`：站点标题（默认值：`在线图集`）。
+- `SITE_ICON`：站点图标 URL（默认值：`https://i.obai.cc/favicon.ico`）。
+- `SITE_DYNAMIC`：是否启用动态加载（默认值：`false`）。
+
+## 路由说明
+
+- `/`：主页面，展示图片分类。
+- `/category/{分类名}`：分类页面，展示分类下的图片。
+- `/login`：登录页面，用于认证访问。
+- `/api/index`：获取分类的 JSON 数据（动态模式）。
+- `/api/category/{分类名}`：获取分类下图片的 JSON 数据（动态模式）。
+- `/images/{分类名}/{图片名}`：访问图片文件。
+
+## 启动项目
+
+1. 确保已安装 Go 环境。
+2. 将项目克隆到本地并进入项目目录。
+3. 使用以下命令运行项目：
+   ```sh
+   go run main.go
+   ```