docs(readme): streamline and condense the overview#2
Conversation
The README had grown long with full reference sections for every method (proxy, catalog, apps, raw results, development), which buried the core getting-started flow. Condense it to the essentials — quick start, install, optional precise types, configuration, and error handling — and fold the remaining methods into a compact "More" list that points to examples/ for runnable usage. Add npm and license badges to surface package status at a glance. Signed-off-by: Kevin Cui <bh@bugs.cc>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
Summary by CodeRabbitDocumentation
WalkthroughThe README.md is rewritten with a zero-dependency/loose-typing-first narrative. The introduction and usage examples are reformatted around dynamic action execution and namespace sugar. A new "Precise types (optional)" section documents the 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
Comment |
The README had grown long with full reference sections for every method (proxy, catalog, apps, raw results, development), which buried the core getting-started flow. Condense it to the essentials — quick start, install, optional precise types, configuration, and error handling — and fold the remaining methods into a compact "More" list that points to examples/ for runnable usage. Add npm and license badges to surface package status at a glance.