From cf5ba2c9a07508003fa10e76efd6b1c10dc5ebe5 Mon Sep 17 00:00:00 2001
From: HughhhhCoder <hughz926@gmail.com>
Date: Fri, 21 Aug 2026 12:56:45 +0800
Subject: [PATCH] docs: complete project documentation

---
 README.md       | 16 ++++++++++++++++
 README.zh-CN.md | 16 ++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/README.md b/README.md
index c12d065..4734482 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,20 @@ HTooL is a small, task-oriented toolkit for writing, development, and everyday d
 | System & data | Data processor | Regex testing, URL encoding/decoding, Base64, MD5, and SHA-256 |
 | System & data | IP lookup | IPv4 location, timezone, and network information |
 
+## Tool routes
+
+Each tool is available directly through a client-side route, which makes it easy to bookmark or deep-link a workflow:
+
+| Route | Tool |
+| --- | --- |
+| `/markdown` | Markdown editor |
+| `/markdown-html` | Markdown ↔ HTML converter |
+| `/image-converter` | Image converter |
+| `/qrcode` | QR code generator and decoder |
+| `/drawing-board` | Drawing board |
+| `/data-processor` | Regex, encoding, and hashing utilities |
+| `/ip-location` | IP location lookup |
+
 ## Highlights
 
 - Browser-first: image conversion, QR codes, drawing, and text processing run locally by default.
@@ -118,6 +132,8 @@ Copy `.env.example` to `.env` and adjust as needed:
 - Vercel Analytics is disabled by default and is enabled only with `VITE_ENABLE_ANALYTICS=true`.
 - Markdown and HTML previews are sanitized with DOMPurify. Review downloaded HTML before publishing it, especially when the source is untrusted.
 
+The Markdown editor's local folder workflow uses the browser File System Access API and requires an explicit user permission. Support varies by browser; the rest of the toolbox remains useful without granting folder access.
+
 ## Project structure
 
 ```text
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 1e68533..1e86f45 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -37,6 +37,20 @@ HTooL 面向写作、开发和日常信息处理场景，优先把数据留在
 | 系统与数据 | 数据处理工具 | 正则测试、URL 编码/解码、Base64、MD5 与 SHA-256 |
 | 系统与数据 | IP 地址定位 | 查询 IPv4 的地域、时区与运营商信息 |
 
+## 工具路由
+
+每个工具都有独立的前端路由，可以直接收藏或分享某个具体工作流：
+
+| 路由 | 工具 |
+| --- | --- |
+| `/markdown` | Markdown 编辑器 |
+| `/markdown-html` | Markdown ↔ HTML 转换器 |
+| `/image-converter` | 图片转换器 |
+| `/qrcode` | 二维码生成与解析 |
+| `/drawing-board` | 手绘板 |
+| `/data-processor` | 正则、编码与哈希工具 |
+| `/ip-location` | IP 地址定位 |
+
 ## 主要特点
 
 - 浏览器优先：图片转换、二维码、绘图和文本处理默认在本地完成。
@@ -118,6 +132,8 @@ npm run check
 - Vercel Analytics 默认关闭，只有显式设置 `VITE_ENABLE_ANALYTICS=true` 才会启用。
 - Markdown 预览和 HTML 预览会经过 DOMPurify 清理；下载 HTML 前仍应审阅内容，尤其不要把不可信内容当作生产页面直接发布。
 
+Markdown 编辑器的本地文件夹功能使用浏览器 File System Access API，需要用户显式授权。不同浏览器的支持程度不同；不授予文件夹权限也不影响其他工具使用。
+
 ## 项目结构
 
 ```text