From 356d5e2b4a4e726cbc17d8a3514881ed98b73123 Mon Sep 17 00:00:00 2001 From: oiov Date: Tue, 22 Jul 2025 11:14:23 +0800 Subject: [PATCH] format readme styles --- README.md | 174 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 101 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index cf74781..fef6652 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@
+ WR.DO Logo

WR.DO

+

一站式域名服务平台，集成短链服务、临时邮箱、子域名管理、文件存储和开放API接口。

- 开发文档 · Feedback · English | 简体中文 + 官网 · 部署文档 · 反馈讨论 · English | 简体中文

- GitHub Release + Vercel + Release + Release + GitHub Release
+ contributors star GitHub forks GitHub Issues or Pull Requests
@@ -11,76 +17,6 @@ MIT
-## 简介 - -WR.DO 是一个一站式域名服务平台，集成短链服务、临时邮箱、子域名管理、文件存储和开放API接口。支持自定义链接、密码保护、访问统计；提供无限制临时邮箱收发；管理多域名DNS记录；支持云存储，对接 S3 API；内置网站截图、元数据提取等实用API。提供完整的管理后台，支持用户权限控制和各项服务配置。 - -- 官网: [https://wr.do](https://wr.do) -- Demo: [https://699399.xyz](https://699399.xyz) (管理员账号: `admin@admin.com`, 密码: `123456`) - -## 功能列表 - -- 🔗 **短链服务**： - - 支持自定义短链 - - 支持生成自定义二维码 - - 支持密码保护链接 - - 支持设置过期时间 - - 支持访问统计（实时日志、地图等多维度数据分析） - - 支持调用 API 创建短链 - -- 📮 **临时邮箱服务**： - - 支持创建自定义前缀邮箱 - - 支持过滤未读邮件列表 - - 可创建无限数量邮箱 - - 支持接收无限制邮件 （依赖 Cloudflare Email Worker） - - 支持发送邮件（依赖 Resend） - - 支持 Catch-All 配置 - - 支持 Telegram 推送（多频道/群组） - - 支持调用 API 创建邮箱 - - 支持调用 API 获取收件箱邮件 - -- 🌐 **子域名管理服务**： - - 支持管理多 Cloudflare 账户下的多个域名的 DNS 记录 - - 支持创建多种 DNS 记录类型（CNAME、A、TXT 等） - - 支持开启申请模式（用户提交、管理员审批） - - 支持邮件通知管理员、用户域名申请状态 - -- 💳 **云存储服务** - - 接入多渠道（S3 API）云存储平台（Cloudflare R2、AWS S3） - - 支持单渠道多存储桶配置 - - 动态配置（用户配额设置）文件上传大小限制 - - 支持拖拽、批量、分块上传文件 - - 支持批量删除文件 - - 快捷生成文件短链、二维码 - - 支持部分文件在线预览内容 - - 支持调用 API 上传文件 - -- 📡 **开放接口模块**： - - 获取网站元数据 API - - 获取网站截图 API - - 生成网站二维码 API - - 将网站转换为 Markdown、Text - - 支持所有类型 API 调用统计日志 - - 支持生成用户 API Key，用于第三方调用开放接口 - -- 🔒 **管理员模块**： - - 多维度图表展示网站状态 - - 域名服务配置（动态配置各项服务是否启用，包括短链、临时邮箱（收发邮件）、子域名管理） - - 用户列表管理（设置权限、分配使用额度、禁用用户等） - - 动态配置登录方式 (支持 Google, GitHub, 邮箱验证, 账户密码, LinuxDO) - - 短链管理（管理所有用户创建的短链） - - 邮箱管理（管理所有用户创建的临时邮箱） - - 子域名管理（管理所有用户创建的子域名） - -## 技术栈 - -- Next.js + React + TypeScript -- Tailwind CSS 用于样式设计 -- Prisma ORM 作为数据库工具 -- Cloudflare 作为主要的云基础设施 -- Vercel 作为推荐的部署平台 -- Resend 作为邮件服务 - ## 截图预览 @@ -98,12 +34,104 @@ WR.DO 是一个一站式域名服务平台，集成短链服务、临时邮箱
+ +## 功能列表 + +> Demo: [https://699399.xyz](https://699399.xyz) (管理员账号: `admin@admin.com`, 密码: `123456`) + +
+ 🔗 短链服务 - [功能列表] + +
+ +
+ 📮 域名邮箱服务 - [功能列表] + +
+ +
+🌐 子域名管理服务 - [功能列表] + +
+ +
+📂 文件存储服务 - [功能列表] + +
+ +
+📡 开放接口服务 - [功能列表] + +
+ +
+👑 管理员模块 - [功能列表] + +
+ +## 技术栈 + +- Next.js + React + TypeScript +- Tailwind CSS 用于样式设计 +- Prisma ORM 作为数据库工具 +- Cloudflare 作为主要的云基础设施 +- Vercel 作为推荐的部署平台 +- Resend 作为邮件服务 +- Next-Intl 作为国际化支持 + ## 快速开始 -查看开发者[快速开始](https://wr.do/docs/developer/quick-start)详细文档。 +查看开发者[手把手部署教程](https://wr.do/docs/developer/quick-start-zh)文档。 ## 自部署教程 +> 注意，任何部署方式都需要先配置环境变量，若部署后修改了环境变量，需要**重新部署**才会生效。 + ### 使用 Vercel 部署 [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/oiov/wr.do.git&project-name=wrdo)