Skip to content

Commit 221b608

Browse files
committed
docs: comprehensive usage guide + README badge updates
- docs/USAGE.md: complete user-facing documentation covering: - Installation (basic, extras, Rust backend) - Quick start (route, compress, remember/recall, step) - Core API reference with examples - Enterprise features: tenancy, schema validation, rate limiting, config management, encryption, JWT auth, TTL, health probes, backup/restore - Observability: telemetry, Prometheus, OpenTelemetry, JSONL export - Security: pentest command + hardening checklist - Deployment: blue-green markers, load testing, chaos engineering - Testing commands - README.md: updated version badge 0.3.0→0.5.0, tests 15→135, added link to docs/USAGE.md Verification: 135/135 tests passing, ruff 0, mypy 0
1 parent e42c0e3 commit 221b608

2 files changed

Lines changed: 458 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
**Orchestration layer for AI agents** - CPU-side routing, context compression, and causal memory to reduce token usage by 64%.
44

5-
[![Version](https://img.shields.io/badge/version-0.3.0-blue)](https://github.com/DJLougen/hive)
5+
[![Version](https://img.shields.io/badge/version-0.5.0-blue)](https://github.com/DJLougen/hive)
66
[![Python](https://img.shields.io/badge/python-3.10+-green)](https://python.org)
7-
[![Tests](https://img.shields.io/badge/tests-15%20passed-brightgreen)](https://github.com/DJLougen/hive/actions)
7+
[![Tests](https://img.shields.io/badge/tests-135%20passed-brightgreen)](https://github.com/DJLougen/hive/actions)
88
[![License](https://img.shields.io/badge/license-MIT-yellow)](https://opensource.org/licenses/MIT)
99
[![RTX 3090](https://img.shields.io/badge/RTX%203090-validated-orange)]()
1010
[![DGX Spark](https://img.shields.io/badge/DGX%20Spark-validated-red)]()
@@ -89,6 +89,8 @@ pip install -e ".[dev]"
8989

9090
## Quick Start
9191

92+
📖 **Full usage guide**: [docs/USAGE.md](docs/USAGE.md) — covers enterprise features, security, deployment, and observability.
93+
9294
```python
9395
from hive import HiveStack
9496

0 commit comments

Comments
 (0)