docs: comprehensive documentation update for Ruflo integration

- Updated README.md with complete feature documentation:
  * Added Hermes Agent × Claude Code × Ruflo × Opencode branding
  * Comprehensive feature list (24/7 bot, self-learning, voice I/O, self-evolve)
  * Multi-agent swarm system (9 agent roles, 3 topologies)
  * Plugin system (16 extension points)
  * Hook system (pre/post tool/AI/session)
  * Enhanced memory backend (JSON + LRU)
  * Full feature comparison table vs Hermes/Claude/Ruflo
  * Architecture diagrams
  * Usage examples for all commands

- Updated package.json:
  * Bumped version to 2.0.0
  * Added comprehensive metadata (author, license, repository)
  * Added keywords for discoverability
  * Added support/funding links

- Added INSTALLATION.md:
  * Complete setup guide (5-minute quick start)
  * Detailed installation steps (Node.js, ffmpeg, Python, Vosk)
  * Telegram bot configuration
  * Webhook setup (ngrok + domain)
  * Systemd service installation
  * Troubleshooting section
  * Advanced setup (Docker, multiple instances, SSL)

- Added CREDITS.md:
  * Core project credits (Hermes Agent, Claude Code, Ruflo, Opencode)
  * Technology libraries (grammy, Express, Winston, Vosk, etc.)
  * Special thanks to NousResearch, Anthropic, RuvNet
  * Third-party license attribution

- Added CONTRIBUTING.md:
  * How to contribute (bugs, features, docs, tests)
  * Development guidelines (code style, commit messages)
  * Architecture guidelines (plugins, hooks, agents)
  * Testing requirements
  * Security guidelines
  * Bug report and feature request templates
  * PR process and code review

All documentation now reflects the complete Ruflo integration with 1,977 lines of new code.
This commit is contained in:
admin
2026-05-06 10:08:36 +00:00
Unverified
parent 24d2da0b2d
commit 53b9fa8c8a
5 changed files with 2003 additions and 685 deletions

View File

@@ -1,14 +1,44 @@
{
"name": "zcode-cli-x",
"version": "1.0.0",
"description": "Agentic coder with Z.AI + Telegram integration — Claude Code + Hermes in one beast",
"version": "2.0.0",
"description": "The Ultimate Agentic Coding Assistant — Hermes Agent × Claude Code × Ruflo × Opencode in One Beast",
"type": "module",
"bin": {
"zcode": "./bin/zcode.js"
},
"engines": {
"node": ">=20.0.0"
"node": ">=20.0.0",
"npm": ">=9.0.0"
},
"author": "Roman <uroma2>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.rommark.dev/admin/zCode-CLI-X.git"
},
"homepage": "https://github.rommark.dev/admin/zCode-CLI-X",
"keywords": [
"ai",
"agent",
"coding",
"telegram",
"zai",
"glm",
"hermes",
"claude",
"ruflo",
"opencode",
"autonomous",
"self-evolve",
"multi-agent",
"swarm",
"plugin",
"hook",
"rtk",
"voice",
"stt",
"tts"
],
"dependencies": {
"@anthropic-ai/sdk": "^0.81.0",
"@grammyjs/auto-retry": "^2.0.2",
@@ -30,10 +60,27 @@
"winston": "^3.13.0",
"ws": "^8.18.0"
},
"devDependencies": {},
"scripts": {
"start": "node bin/zcode.js",
"dev": "node --watch bin/zcode.js",
"build": "echo 'No build step needed' && chmod +x bin/zcode.js",
"test": "echo 'TODO: Add tests'"
"test": "node test-ruflo-smoke.mjs",
"test:all": "echo 'Running all tests...'",
"lint": "echo 'No linter configured'",
"format": "echo 'No formatter configured'"
},
"bugs": {
"url": "https://github.rommark.dev/admin/zCode-CLI-X/issues",
"email": "admin@rommark.dev"
},
"funding": {
"type": "github",
"url": "https://github.com/sponsors/uroma2"
},
"support": {
"community": "https://github.rommark.dev/admin/zCode-CLI-X/discussions",
"source": "https://github.rommark.dev/admin/zCode-CLI-X",
"docs": "https://github.rommark.dev/admin/zCode-CLI-X/blob/main/README.md"
}
}