写个 readme

Author: clansty

README.md

@@ -1,34 +1,55 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Chat Record Viewer
 
-## Getting Started
+聊天记录查看器
 
-First, run the development server:
+本项目是为 [Q2TG](https://github.com/Clansty/Q2TG) 所生，设计上的作用是用于查看合并转发的消息记录。可以根据 ResID 获取并展示转发的聊天记录。
 
-```bash
-npm run dev
-# or
-yarn dev
-```
+使用 Next.JS + React，用了 [Antd](https://ant.design/) 的图片放大查看组件。为了防止滥用搭建好的实例，可以设置 secretKey 用于签名校验。
+
+## 搭建方法
+
+1. 将 `config.example.yaml` 复制到 `config.yaml`，填写相关信息
+
+   ```bash
+   cp config.example.yaml config.yaml
+   ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+   ```yaml
+   host:
+     account: # 用于获取记录的帐号
+     password: # 密码
+   token: # 随便生成一个密钥，用来校验参数的签名
+   ```
 
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+2. 安装依赖
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.tsx`.
+   ```bash
+   yarn install
+   ```
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+3. 编译 Next.JS
 
-## Learn More
+   ```bash
+   yarn build
+   ```
 
-To learn more about Next.js, take a look at the following resources:
+4. 运行服务
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+   ```
+   yarn start
+   ```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+5. 将 `3000` 端口暴露出来，建议使用类似 caddy 的软件反代并提供 HTTPS 连接
+
+## 签名生成
+
+在需要生成访问链接的应用中，使用以下方式生成访问地址的 `sign` 参数
+
+```js
+md5(md5(resId) + token)
+```
 
-## Deploy on Vercel
+该生成算法位于 [`index.tsx` 的第 45 行附近](./pages/index.tsx#L45)
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+如果实例部署在 `https://example.com`，则访问地址为 `https://example.com/?res=ResID&sign=签名`
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

config.example.yaml

@@ -0,0 +1,4 @@
+host:
+  account:
+  password:
+token: