oleg-koval / trembita / 24716776379

100%

master: 100%

push

github

docs: Reorganize README with prominent learning path links (#348)

* docs: Add comprehensive learning guide, examples, and educational materials

Create discoverable, hands-on resources to help developers learn and use trembita:

**New Files:**
- LEARNING_GUIDE.md: Complete guide covering core concepts, error handling,
  testing, advanced features, and common patterns
- EXAMPLES.md: Real-world use cases (GitHub API, payments, microservices,
  health checks, webhooks, search, backups)
- examples/rest-api-client.ts: Complete CRUD client starter template
- examples/testing-with-mock-fetch.test.ts: Comprehensive vitest patterns
- examples/resilience-patterns.ts: Retries, circuit breaker, failover, bulkheads
- examples/README.md: Quick navigation for all examples

**Updates:**
- README.md: Add prominent links to learning guide and examples in quick links

This makes trembita more discoverable for new developers and provides
copy-paste-ready code for common scenarios, improving open-source adoption.

https://claude.ai/code/session_01FB3k9PS88Yq1Yuw18T4fuu

* docs: Add quick start guide and architecture documentation

Add two more discovery-focused documents:

**QUICK_START.md** — 2-minute introduction
- What is trembita in plain English
- Install and 3-step usage pattern
- Common patterns (POST, query, headers, retries, testing)
- Error types reference
- Quick comparison with Axios, Node-fetch
- FAQ covering common questions

**ARCHITECTURE.md** — Visual system design guide
- System architecture diagram
- Request pipeline (step-by-step)
- Error handling flow chart
- Feature matrix (default vs optional)
- Integration patterns (simple to full-stack)
- Data flow diagrams
- Module structure
- Design principles
- When to use each feature
- Full lifecycle example

These documents improve discoverability for developers at different levels:
- QUICK_START.md for quick learners (2 min)
- LEARNING_GUIDE.md for thorough understanding (30 min)
- ARCHITECTURE.md for syst... (continued)

211 of 211 branches covered (100.0%)

Branch coverage included in aggregate %.

572 of 572 relevant lines covered (100.0%)

17.54 hits per line