upd docs

2025-04-13 11:24:33 +08:00
parent 292f5911c8
commit ce47804db3
6 changed files with 34 additions and 25 deletions
@@ -7,15 +7,12 @@

 ## 功能

- 🔗 **短链生成**：生成附有访问者统计信息的短链接 (支持密码保护)
- 📮 **临时邮箱**：创建多个临时邮箱接收和发送邮件
+- 🔗 **短链生成**：生成附有访问者统计信息的短链接 (支持密码保护, 支持调用 API)
+- 📮 **临时邮箱**：创建多个临时邮箱接收和发送邮件（支持调用 API）
 - 🌐 **多租户支持**：无缝管理多个 DNS 记录
- ⚡ **即时记录创建**：快速设置 CNAME、A 等记录
- 📸 **截图 API**：访问截图 API
- � **元数据抓取 API**：访问元数据抓取 API
+- 📸 **截图 API**：访问截图 API、网站元数据抓取 API
 - �😀 **权限管理**：方便审核的管理员面板
 - 🔒 **安全可靠**：基于 Cloudflare 强大的 DNS API
- 💰 **免费注册**：创建和管理记录无需付费

 ## Screenshots

@@ -7,15 +7,13 @@

 ## Features

- 🔗 **URL Shortening:** Generate short links with visitor analytic and password
- 📮 **Email Support:** Receive emails and send emails
+- 🔗 **URL Shortening:** Generate short links with visitor analytic and password(support api)
+- 📮 **Email Support:** Receive emails and send emails(support api)
+- 💬 **P2P Chat:** Start chat in seconds
 - 🌐 **Multi-Tenant Support:** Manage multiple DNS records seamlessly
- ⚡ **Instant Record Creation:** Set up CNAME, A, and other records quickly
- 📸 **Screenshot API:** Access to screenshot API.
- 💯 **Meta Scraping API:** Access to meta scraping API.
+- 📸 **Screenshot API:** Access to screenshot api、website meta-info scraping api.
 - 😀 **Permission Management:** A convenient admin panel for auditing
 - 🔒 **Secure & Reliable:** Built on Cloudflare's robust DNS API
- 💰 **Free Registration:** No cost to create and manage records

 ## Screenshots

@@ -59,6 +59,8 @@ Copy/paste the `.env.example` in the `.env` file:
 | NEXT_PUBLIC_SHORT_DOMAINS | `wr.do,uv.do` | The list of short domains. Separated by `,` |
 | NEXT_PUBLIC_EMAIL_DOMAINS | `wr.do,uv.do` | The list of email domains. Separated by `,` |

+> `NEXT_PUBLIC_SHORT_DOMAINS`、`NEXT_PUBLIC_EMAIL_DOMAINS` is used to limit the short domain name and email domain name.
+
 - How to get `GOOGLE_CLIENT_ID`、`GITHUB_ID`, see [Authentification](/docs/developer/authentification).
 - How to get `RESEND_API_KEY`, see [Email](/docs/developer/email).
 - How to get `CLOUDFLARE_ZONE_ID`、`CLOUDFLARE_API_KEY`、`CLOUDFLARE_EMAIL`, see [Cloudflare Configs](/docs/developer/cloudflare).
@@ -5,13 +5,13 @@ description: Welcome to the WR.DO documentation.

 ## Features

+- 🔗 **URL Shortening:** Generate short links with visitor analytic and password(support api)
+- 📮 **Email Support:** Receive emails and send emails(support api)
+- 💬 **P2P Chat:** Start chat in seconds
 - 🌐 **Multi-Tenant Support:** Manage multiple DNS records seamlessly
- ⚡ **Instant Record Creation:** Set up CNAME, A, and other records quickly
- 🔗 **URL Shortening:** Generate short links with visitor statistics attached
- 📸 **Screenshot API:** Access to screenshot API.
- 💯 **Meta Scraping API:** Access to meta scraping API.
+- 📸 **Screenshot API:** Access to screenshot api、website meta-info scraping api.
+- 😀 **Permission Management:** A convenient admin panel for auditing
 - 🔒 **Secure & Reliable:** Built on Cloudflare's robust DNS API
- 💰 **Free Registration:** No cost to create and manage records

 ## Screenshots

@@ -10,13 +10,6 @@ Welcome to WR.DO, a multi-tenant DNS record management system based on Cloudflar
 1. **Visit the Website**: First, visit https://wr.do .
 3. **Register/Log In to Your Account**: Use the registered email or Google/Github account to log in on the [Login page](https://wr.do/login).

-## Creating DNS Records
-
-1. **Navigate to DNS Management Page**: After logging in, you will see a "DNS Management" option in the navigation bar, click [DNS Management](https://wr.do/dashboard/records) to proceed.
-2. **Add Record**: Click the "Add Record" button and select the type of record you need (such as CNAME, A, etc.).
-3. **Fill in Details**: Enter the hostname, target address, and other details as prompted.
-4. **Save Record**: After confirming everything is correct, click the "Save" button.
-
 ## Generating Short Links

 1. **Navigate to Short Links Page**: Select the [Short Links](https://wr.do/dashboard/urls) option in the navigation bar.
@@ -24,6 +17,25 @@ Welcome to WR.DO, a multi-tenant DNS record management system based on Cloudflar
 3. **Generate Short Link**: Click the "Generate" button, and the system will automatically create a short link for you.
 4. **Copy and Use**: Click the "Copy" button to copy the short link to your clipboard, and you can use it wherever needed.

+## Creating Email Addresses
+
+1. **Navigate to Email Management Page**: After logging in, you will see a "Email Management" option in the navigation bar, click [Email Management](https://wr.do/emails) to proceed.
+2. **Add Email**: Click the "Create New Email" button to create a new email address.
+3. **Ready to Use**: Once the email address is created, you can start using it for email communication.
+
+## Creating Chat Room 
+
+1. **Navigate to Chat Room Page**: After logging in, you will see a "Chat Room" option in the navigation bar, click [Chat Room](https://wr.do/chat) to proceed.
+2. **Share Room**: Click the "Share Room" button to copy the room link and share it with others.
+3. **Connect Room**: Once other users join the room, they can start chatting.
+
+## Creating DNS Records
+
+1. **Navigate to DNS Management Page**: After logging in, you will see a "DNS Management" option in the navigation bar, click [DNS Management](https://wr.do/dashboard/records) to proceed.
+2. **Add Record**: Click the "Add Record" button and select the type of record you need (such as CNAME, A, etc.).
+3. **Fill in Details**: Enter the hostname, target address, and other details as prompted.
+4. **Save Record**: After confirming everything is correct, click the "Save" button.
+
 ## Real-Time Updates

 - **DNS Record Changes**: Once you update or add new DNS records, the system will immediately begin to propagate these changes.