Refactored the boilerplate code to CleverAgents

README.md

@@ -1,46 +1,42 @@
-# Python Project Boilerplate
+# CleverAgents Core
 
-Start new Python applications quickly with a minimal, well-structured foundation.
+CleverAgents is the Python-first migration of the Plandex automation platform. It provides a unified `agents` CLI, embedded runtime, and service orchestration tools that mirror the original Go workflows while embracing modern Python tooling.
 
-## Features
+## Highlights
 
-- Python package layout under `src/`
-- `pyproject.toml` with placeholders for metadata and dependencies
-- Ruff formatting & linting
-- Nox automation for format, lint, type-check, tests, docs, build
-- MkDocs configured for documentation
-- Ready-made dev container configuration
+- Unified CLI entry points: `cleveragents` and `agents`
+- Fast Typer/Click-based interface with parity for help/version behavior
+- Behavior-driven coverage via Behave and Robot Framework
+- Nox automation for linting, typing, testing, docs, builds, and benchmarks
+- MkDocs-powered documentation with CleverAgents branding
 
 ## Quick Start
 
 ```bash
-# clone the template
-# replace <your-org> and <project-name>
-git clone https://example.com/<your-org>/<project-name>.git
-cd <project-name>
+# clone the CleverAgents core repository
+git clone https://git.cleverthis.com/cleveragents/core.git
+cd core
 
-# optional: rename package directory under src/
-
-# create virtual environment and install dependencies
+# install dependencies
 python -m venv .venv
 source .venv/bin/activate
-pip install -e .[dev]
+pip install -e .[tests,docs]
 
-# run quality checks
-nox -s format lint typecheck tests
-
-# run the sample CLI
-python -m boilerplate
+# verify the CLI
+agents --help
+agents --version
 ```
 
-## Replace Placeholders
+## Developing
 
-Update the following files with real project information:
-
-- `pyproject.toml`
-- `mkdocs.yml`
-- `docs/index.md`
-- `README.md`
+```bash
+# run validation suites
+nox -s format
+nox -s lint
+oxt -s typecheck
+nox -s unit_tests
+nox -s integration_tests
+```
 
 ## Documentation
 
@@ -51,5 +47,4 @@ nox -s serve_docs
 
 ## Tests
 
-Simple placeholder tests live in `tests/`.
-Run them with `nox -s tests` or `pytest`.
+Behave feature scenarios live under `features/` and Robot suites under `robot/`. Use the Nox sessions above to execute them in parity with the implementation plan.