headroom/docs
chopratejas 3ebcd89d46 Rewrite README + add Integration Guide
README: 694 → 203 lines. Crisp, scannable, links to docs.
- compress() as the hero quickstart (not proxy)
- Integration table: compress(), LiteLLM, ASGI, proxy, Agno, LangChain
- LangChain marked as experimental
- "Already have a proxy?" callout linking to Integration Guide
- Architecture: ContentRouter (not SmartCrusher) as the primary compressor

New: docs/integration-guide.md
- Detailed setup for every integration path
- compress() with Anthropic, OpenAI, LiteLLM, raw HTTP
- LiteLLM callback + LiteLLM proxy ASGI middleware
- ASGI middleware for any FastAPI/Starlette app
- Compression hooks for advanced customization
- FAQ section

Fix: compress() uses default pipeline (CacheAligner + ContentRouter +
IntelligentContext) instead of manually specifying SmartCrusher.
2026-02-19 10:17:33 -08:00
..
plans Add dynamic anchor selection with content deduplication 2026-01-21 00:19:05 -08:00
agno.md Add feature coverage and known limitations to Agno docs 2026-01-16 16:25:31 -08:00
api.md Add IntelligentContextManager for semantic-aware context management 2026-01-18 22:22:48 -08:00
ARCHITECTURE.md docs: update documentation for IntelligentContext TOIN + CCR integration 2026-01-27 16:08:36 -08:00
benchmarks.md Fix mypy errors in html_extraction.py 2026-01-31 10:16:41 -08:00
ccr.md docs: update documentation for IntelligentContext TOIN + CCR integration 2026-01-27 16:08:36 -08:00
compression.md Add universal compression module with ML-based content detection 2026-01-15 15:26:14 -08:00
configuration.md docs: update documentation for IntelligentContext TOIN + CCR integration 2026-01-27 16:08:36 -08:00
errors.md v0.2.2: Add CCR Response Handler, Context Tracker, and restructure docs 2026-01-14 13:03:41 -08:00
getting-started.md Prepare for OSS release v0.2.0 2026-01-07 11:36:44 -08:00
image-compression.md Add image token compression with trained ML router 2026-01-25 22:40:43 -08:00
index.md Add MkDocs GitHub Pages documentation site 2026-01-30 20:33:29 -08:00
integration-guide.md Rewrite README + add Integration Guide 2026-02-19 10:17:33 -08:00
langchain.md Add seamless LangChain integration 2026-01-14 16:03:34 -08:00
llmlingua.md v0.2.2: Add CCR Response Handler, Context Tracker, and restructure docs 2026-01-14 13:03:41 -08:00
macos-deployment.md docs(deployment): add macOS LaunchAgent deployment guide and templates 2026-01-19 13:34:52 -08:00
mcp.md Add MCP CLI for Claude Code subscription users 2026-02-02 11:05:24 -08:00
memory.md Update memory documentation for HierarchicalMemory system 2026-01-22 23:37:14 -08:00
metrics.md v0.2.2: Add CCR Response Handler, Context Tracker, and restructure docs 2026-01-14 13:03:41 -08:00
proxy.md docs: update documentation for IntelligentContext TOIN + CCR integration 2026-01-27 16:08:36 -08:00
quickstart.md Publish headroom-ai v0.2.0 to PyPI with DevEx fixes 2026-01-10 14:51:08 -08:00
sdk.md v0.2.2: Add CCR Response Handler, Context Tracker, and restructure docs 2026-01-14 13:03:41 -08:00
text-compression.md v0.2.2: Add CCR Response Handler, Context Tracker, and restructure docs 2026-01-14 13:03:41 -08:00
transforms.md feat(toin): add TOIN + CCR integration to IntelligentContextManager 2026-01-27 16:08:36 -08:00
troubleshooting.md Publish headroom-ai v0.2.0 to PyPI with DevEx fixes 2026-01-10 14:51:08 -08:00