Skip to content

Commit 4be140c

Browse files
ReasonKit Botclaude
andcommitted
docs: add version/maturity tables and verification steps to READMEs
- Add clear maturity status tables to all three READMEs - Add installation verification examples - Link to CHANGELOG and Releases - Add CONTRIBUTING.md to reasonkit-mem and reasonkit-web - Clarify stable vs beta features 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent f5ab979 commit 4be140c

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ rk-core think --profile balanced "Should we migrate to microservices?"
6767

6868
Each ThinkTool acts as a **variance reduction filter**, transforming probabilistic outputs into increasingly deterministic reasoning paths.
6969

70+
![ReasonKit Protocol Chain - Turn Prompts into Protocols](./brand/readme/powercombo_process.png)
71+
7072
![ReasonKit ThinkTool Chain - Variance Reduction](./brand/readme/thinktool_cards_deck.svg)
7173
![ReasonKit Variance Reduction Chart](./brand/readme/chart_variance_reduction.png)
7274

@@ -170,6 +172,8 @@ The ReasonKit architecture uses a **Protocol Engine** wrapper to enforce determi
170172

171173
![ReasonKit Core Architecture Exploded View](./brand/readme/core_architecture_exploded.png)
172174

175+
![ReasonKit ThinkTool Chain Architecture](./brand/readme/architecture_diagram.png)
176+
173177
**Three-Layer Architecture:**
174178

175179
1. **Probabilistic LLM** (Unavoidable)
@@ -411,6 +415,33 @@ See [Community Badges](brand/COMMUNITY_BADGES.md) for all variants and usage gui
411415

412416
---
413417

418+
## Version & Maturity
419+
420+
| Component | Status | Notes |
421+
|-----------|--------|-------|
422+
| **ThinkTools Chain** | ✅ Stable | Core reasoning protocols production-ready |
423+
| **MCP Server** | ✅ Stable | Model Context Protocol integration |
424+
| **CLI** | 🔶 Scaffolded | `mcp`, `serve-mcp`, `completions` work; others planned |
425+
| **Memory Features** | ✅ Stable | Via `reasonkit-mem` crate |
426+
| **Python Bindings** | 🔶 Beta | Build from source with `--features python` |
427+
428+
**Current Version:** v0.1.2 | [CHANGELOG](CHANGELOG.md) | [Releases](https://github.com/reasonkit/reasonkit-core/releases)
429+
430+
### Verify Installation
431+
432+
```bash
433+
# Check version
434+
rk-core --version
435+
436+
# Verify MCP server starts
437+
rk-core serve-mcp --help
438+
439+
# Run a quick test (requires LLM API key)
440+
OPENAI_API_KEY=your-key rk-core mcp
441+
```
442+
443+
---
444+
414445
## License
415446

416447
**Apache 2.0** - See [LICENSE](https://github.com/reasonkit/reasonkit-core/blob/main/LICENSE)

0 commit comments

Comments
 (0)