|
|
5f4743e086
|
Make README more concise with ADVANCED.md
Restructure documentation for better discoverability:
Changes:
- README.md: 551 → 181 lines (67% reduction)
- ADVANCED.md: New comprehensive guide (500+ lines)
README.md now contains:
✅ Features overview
✅ Installation
✅ Quick start examples (offerer & answerer)
✅ Core API summary
✅ Links to advanced docs
ADVANCED.md contains:
📚 Complete API reference (all methods)
📚 Type definitions
📚 Platform support details (Browser & Node.js)
📚 Advanced usage patterns
📚 Username rules and FQN format
📚 Migration guides
📚 Examples
Benefits:
- Faster onboarding for new users
- Essential info in README
- Detailed reference still accessible
- Better documentation structure
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
2025-12-12 23:14:54 +01:00 |
|
