Skip to content

docs: 按当前功能重写 README - #10

Merged
Freecode100Year merged 1 commit into
mainfrom
docs/readme-rewrite
Oct 30, 2026
Merged

Freecode100Year merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@Freecode100Year

Copy link
Copy Markdown
Owner

概要

按项目当前的功能重写 README:按读者需要的顺序组织,删除过时内容。

新结构

  1. 一个文件,三种身份(流程图)
  2. 三步开始聊天(标题、口令、安全码)
  3. 功能一览表
  4. 中继:经典和去中心化的区别、在文件里临时换中继、让所有人一起换
  5. 自己当中继:五种方式,从 node index.html 到 Cloudflare
  6. 能做什么,不能做什么
  7. 安全与隐私
  8. 常见问题
  9. 给开发者(目录结构、测试命令、文档入口)

删除的过时内容

  • 「网页链接只支持站点预设的中继」:现在网站可以打开任意中继的链接。
  • 旧的测试数量、旧的按钮名称。
  • 重复描述的段落。

文档链接和锚点已逐个核对;Mermaid 流程图已在本地渲染确认。只改 README。


Generated by Claude Code

One file, three roles; three steps to chat (title, password, safety code);
a feature table; classic vs decentralized relays; five ways to run a relay
from `node index.html` to Cloudflare; limits; security and privacy; FAQ;
developer layout. Drops stale parts (web links limited to preset relays,
old test counts, old button names).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PCUwNSXQdqfDSugmFo4qmM
@Freecode100Year
Freecode100Year merged commit 6a3f7d7 into main Oct 30, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants