From d8a7e8ad4acc5a114497fc8352c3e8691dc9f0e7 Mon Sep 17 00:00:00 2001 From: Clo <122717146+Cloriskitty@users.noreply.github.com> Date: Mon, 30 Mar 2026 22:13:01 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20improve=20README=20=E2=80=94=20unify=20?= =?UTF-8?q?positioning,=20add=20Why=20section,=20fix=20clone=20URL,=20reor?= =?UTF-8?q?der=20Quick=20Start?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 77 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 40 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index e05d706..4f93de1 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@ # OmniClaw -OmniClaw is the economic control and trust infrastructure for autonomous agents — enabling them to pay, get paid, and transact securely under real-time policy enforcement. +The economic control and trust infrastructure for autonomous agents — enabling them to pay, get paid, and transact securely under real-time policy enforcement. -It sits between raw wallet infrastructure and production payment flows so AI agents and AI-powered apps can move money with better safety, trust, and operator control. Instead of wiring wallets, payment routing, guardrails, intents, trust checks, and recovery flows by hand, OmniClaw gives you one SDK. +## Why OmniClaw + +Every AI agent that touches money needs the same handful of things: wallet orchestration, payment routing, spending guardrails, trust evaluation, audit trails, and recovery flows. Today teams wire these by hand, one integration at a time, and re-learn the same compliance lessons the hard way. + +OmniClaw replaces that patchwork with one SDK. You get guarded execution, policy enforcement, and regulatory-aware defaults out of the box — so you can focus on what your agent actually does, not how it moves money. ## Key Capabilities -- **For Agents That Pay** — guarded `pay()` execution, `simulate()` before funds move, x402 and direct transfer routing, cross-chain USDC flows, nanopayments via Circle Gateway -- **For Agents That Earn** — Seller SDK, `sell()` decorator, facilitated transfers, trust-gated access -- **For Operators That Control** — policy enforcement, spending limits, velocity controls, circuit breakers, audit-ready logs, recovery flows +**For Agents That Pay** — guarded `pay()` execution, `simulate()` before funds move, x402 and direct transfer routing, cross-chain USDC flows, nanopayments via Circle Gateway + +**For Agents That Earn** — Seller SDK, `sell()` decorator, facilitated transfers, trust-gated access + +**For Operators That Control** — policy enforcement, spending limits, velocity controls, circuit breakers, audit-ready logs, recovery flows ## Install @@ -24,38 +30,42 @@ uv sync --extra dev ## Quick Start -### For Agents Using the CLI +### 1. Run the Server ```bash -pip install omniclaw -omniclaw-cli configure --server-url --token --wallet primary +git clone https://github.com/omnuron/omniclaw.git +cd omniclaw +``` + +Create a `.env` file with your Circle credentials: + +``` +CIRCLE_API_KEY=your_circle_api_key +ENTITY_SECRET=your_entity_secret ``` -### For Owners Running the Server +Start the server: ```bash -# Clone and start -git clone https://github.com/omniclaw/omniclaw.git -cd omniclaw docker-compose up -d - # Server runs at http://localhost:8088 ``` -**Required environment variables:** -``` -CIRCLE_API_KEY=your_circle_api_key -ENTITY_SECRET=your_entity_secret +Verify the setup: + +```bash +omniclaw doctor # Verify credentials +omniclaw env # List all env vars ``` -1. Create a `.env` file: +### 2. Connect the CLI -``` -CIRCLE_API_KEY=your_circle_api_key -ENTITY_SECRET=your_entity_secret +```bash +pip install omniclaw +omniclaw-cli configure --server-url http://localhost:8088 --token --wallet primary ``` -2. Configure in code: +### 3. Use in Code ```python from omniclaw import OmniClaw, Network @@ -63,29 +73,22 @@ from omniclaw import OmniClaw, Network client = OmniClaw(network=Network.BASE_SEPOLIA) ``` -3. Verify setup: - -```bash -omniclaw doctor # Verify credentials -omniclaw env # List all env vars -``` - ## Documentation -For detailed guides and architecture docs, see the **[Wiki](https://github.com/omnuron/omniclaw/wiki)**: +For detailed guides and architecture docs, see the [Wiki](../../wiki): | Page | Description | |------|-------------| -| [Getting Started](https://github.com/omnuron/omniclaw/wiki/Getting-Started) | Full installation, environment setup, and first payment walkthrough | -| [Architecture](https://github.com/omnuron/omniclaw/wiki/Architecture) | System design, module breakdown, and payment flow | -| [Compliance Design](https://github.com/omnuron/omniclaw/wiki/Compliance-Design) | Authorization traceability, regulatory alignment (CLARITY Act, GENIUS Act), and gray zone analysis | -| [Trust & ERC-8004](https://github.com/omnuron/omniclaw/wiki/Trust-and-ERC-8004) | Trust evaluation framework, on-chain signals, and audit comparison | -| [API Reference](https://github.com/omnuron/omniclaw/wiki/API-Reference) | `pay()`, `simulate()`, `sell()`, NanoPayment, Trust, CLI | -| [Contributing Guide](https://github.com/omnuron/omniclaw/wiki/Contributing-Guide) | Dev setup, branch workflow, commit conventions, code quality | +| [Getting Started](../../wiki/Getting-Started) | Full installation, environment setup, and first payment walkthrough | +| [Architecture](../../wiki/Architecture) | System design, module breakdown, and payment flow | +| [Compliance Design](../../wiki/Compliance-Design) | Authorization traceability, regulatory alignment (CLARITY Act, GENIUS Act), and gray-zone analysis | +| [Trust & ERC-8004](../../wiki/Trust-&-ERC-8004) | Trust evaluation framework, on-chain signals, and audit comparison | +| [API Reference](../../wiki/API-Reference) | `pay()`, `simulate()`, `sell()`, NanoPayment, Trust, CLI | +| [Contributing Guide](../../wiki/Contributing-Guide) | Dev setup, branch workflow, commit conventions, code quality | ## Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Contributing Guide](https://github.com/omnuron/omniclaw/wiki/Contributing-Guide) for development setup, coding standards, and how to submit pull requests. +See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Contributing Guide](../../wiki/Contributing-Guide) for development setup, coding standards, and how to submit pull requests. ## License