Skip to content

docs: overhaul project introduction and feature comparison across READMEs - #1

Merged
dengyie merged 1 commit into
mainfrom
docs/update-readme-intro
Sep 13, 2026
Merged

dengyie merged 1 commit into
mainfrom
docs/update-readme-intro

Conversation

@dengyie

@dengyie dengyie commented Sep 13, 2026

Copy link
Copy Markdown
Owner

Summary

Overhaul the project introduction in both README.md and README.zh-CN.md based on the latest Obsidian documentation and production features:

  1. Dual-Protocol Positioning: Highlight native OpenAI and Anthropic Messages protocol support with direct Claude Code CLI connection and built-in upstream neutralizer (11128 false-positive bypass).
  2. Context & Pain Points: Detail the real developer challenges around CNB AI credits (intranet isolation, pipeline-only token auth, enforced streaming, and ephemeral workspace lifecycles).
  3. v5.2 High Availability: Document zero-token pipeline architecture, auto dynamic DNS/upstream relaying, and dual-watchdog silent self-healing against CI cron dormancy.
  4. Comprehensive Comparison Matrix: Add a feature comparison table comparing cnb2api against community web-scraping NPC alternatives and direct calling.
  5. Zero Dependencies & Quota CLI: Highlight zero npm dependencies and the built-in terminal quota dashboard.

…DMEs

- Highlight native OpenAI + Anthropic dual-protocol support and Claude Code direct connect
- Detail background, pain points (intranet isolation, pipeline auth, ephemeral lifecycle)
- Add comprehensive comparison matrix against community NPC reverse-proxy alternatives
- Document v5.2 zero-token & dual-watchdog self-healing architecture
- Update English and Chinese documentation synchronously
@dengyie
dengyie merged commit d1d0f23 into main Sep 13, 2026
2 checks passed
@dengyie
dengyie deleted the docs/update-readme-intro branch September 13, 2026 21:56
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.

1 participant