Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zmh-program committed Oct 1, 2024
1 parent 045e0fc commit 6f98761
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# 🧪 Next Whois UI

😎 轻量且美观的 Whois 查询工具
😎 现代代 Whois 查询工具

[English](README.md) | [简体中文](README_CN.md)

Expand All @@ -17,32 +17,32 @@

无需多言,直接试试吧!🥳

1.**漂亮的界面**采用现代设计的 [Shadcn UI](https://ui.shadcn.com),让您使用时感到舒适
2. 📱 **响应式设计**适配手机✅ / 平板✅ / 桌面✅,并支持 PWA 应用。
1.**美观界面**采用现代简约设计的 [Shadcn UI](https://ui.shadcn.com) 风格
2. 📱 **响应式设计**适配手机端✅ / Pad✅ / 桌面端✅,并支持 PWA 应用。
3. 🌈 **多主题支持**:支持多种主题(*亮色 & 暗色*),系统主题自动检测,随心切换。
4. 🚀 **灵活的查询**:基于 Next.js,支持无服务器部署,查询速度快
4. 🚀 **灵活的查询**:基于 Next.js,支持无服务器部署,更快查询速度
5. 📚 **历史记录**:历史记录存储在本地存储中,方便查看和查询历史。
6. 📡 **开放 API**:提供简单的 whois 查询 API,易于与其他服务集成。
7. 🌍 **IPv4 & IPv6 Whois 查询**:支持 IPv4、IPv6、域名、ASN、CIDR 的 Whois 查询。
8. 📦 **查询结果分享**:支持获取 Whois 查询结果,方便分享和保存。
9. 📡 **Whois 缓存**:支持基于 Redis 的 Whois 缓存,提升查询速度。
10. 🌍 [进行中] **国际化**:支持多语言。([#6](https://github.com/zmh-program/next-whois-ui/issues/6))
10. 🌍 [计划] **国际化**:支持多语言。([#6](https://github.com/zmh-program/next-whois-ui/issues/6))

👉 [创建拉取请求](https://github.com/zmh-program/next-whois-ui/pulls)
👉 [贡献代码](https://github.com/zmh-program/next-whois-ui/pulls)

## 部署

#### `1` 🚀 平台(推荐)
#### `1` 🚀 云平台部署(推荐)

[Vercel](https://vercel.com/import/project?template=https://github.com/zmh-program/next-whois-ui) / [Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/zmh-program/next-whois-ui) / [Zeabur](https://zeabur.com/templates/UHCCCT)

#### `2` 🐳 Docker
#### `2` 🐳 Docker 部署

```bash
docker run -d -p 3000:3000 programzmh/next-whois-ui
```

#### `3` 🔨 源代码
#### `3` 🔨 源码部署

```bash
git clone https://github.com/zmh-program/next-whois-ui
Expand Down Expand Up @@ -75,7 +75,7 @@ pnpm dev
- `REDIS_DB`: Redis 数据库(默认值:0)
- `REDIS_CACHE_TTL`: Redis 缓存 TTL 秒数(默认值:3600)

## 📝 API 参考
## 📝 API 文档

`GET` `/api/lookup?query=google.com`

Expand Down Expand Up @@ -141,7 +141,7 @@ pnpm dev
</details>

<details>
<summary><strong>错误响应</strong> 内部服务器错误 (500)</summary>
<summary><strong>错误响应</strong> Internal Server Error (500)</summary>

```json
{
Expand All @@ -154,7 +154,7 @@ pnpm dev
</details>

<details>
<summary><strong>错误响应</strong> 错误请求 (400)</summary>
<summary><strong>错误响应</strong> Bad Request (400)</summary>

```json
{
Expand All @@ -176,4 +176,4 @@ pnpm dev

👉 [TLDs Whois 解析器库源码](./src/lib/whois/lib.ts)

❤ 提示: 部分 TLDs 的 Whois 解析器可能暂不兼容,感谢您提交 [拉取请求](https://github.com/zmh-program/next-whois-ui/pulls) 以便支持更多 TLDs!
❤ 提示: 部分 TLDs 的 Whois 解析器可能暂不兼容,感谢您提交 [贡献](https://github.com/zmh-program/next-whois-ui/pulls) 以便支持更多 TLDs!
Binary file added docs/cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6f98761

Please sign in to comment.