Skip to content

Commit 39da23b

Browse files
authored
Update README.md
1 parent 0d6b423 commit 39da23b

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
<div align="center">
77
<a href="#"><img alt="Stability" src="https://img.shields.io/badge/Status-Stable%20v1.0.0-brightgreen"/></a>
8-
<a href="https://www.npmjs.com/package/@commandlayer/protocol-commons">
9-
<img alt="NPM Version" src="https://img.shields.io/npm/v/@commandlayer/protocol-commons?color=brightgreen"/>
8+
<a href="https://www.npmjs.com/package/@commandlayer/commons">
9+
<img alt="NPM Version" src="https://img.shields.io/npm/v/@commandlayer/commons?color=brightgreen"/>
1010
</a>
1111
<a href="https://github.com/commandlayer/protocol-commons/actions/workflows/validate.yml">
1212
<img alt="CI Status" src="https://github.com/commandlayer/protocol-commons/actions/workflows/validate.yml/badge.svg?branch=main"/>
@@ -16,6 +16,7 @@
1616
</a>
1717
</div>
1818

19+
1920
----
2021

2122
Autonomous agents fail at scale without shared meaning:
@@ -53,21 +54,21 @@ SDKs → Runtimes → x402 → ENS → Receipts
5354
---
5455
## Quickstart
5556

56-
```bash
57+
```
5758
npm install @commandlayer/commons ajv
58-
5959
```
6060
**Validate a request against a canonical verb schema**
61+
6162
```
6263
npx cl-validate examples/v1.0.0/commons/summarize/request.json
6364
# ✓ VALID — trace: bafybeieoynknza...
6465
```
6566
**Programmatic usage**
66-
```
67+
```js
6768
import Ajv from "ajv";
6869
import analyzeRequest from "@commandlayer/commons/schemas/v1.0.0/commons/analyze/requests/analyze.request.schema.json";
6970

70-
const ajv = new Ajv({ strict: true });
71+
const ajv = new Ajv({ strict: true, allErrors: true });
7172
const validate = ajv.compile(analyzeRequest);
7273

7374
const input = {
@@ -78,6 +79,7 @@ const input = {
7879
console.log(validate(input)); // true or false
7980
console.log(validate.errors); // diagnostics if invalid
8081

82+
8183
```
8284

8385
## What Commons enables
@@ -91,6 +93,27 @@ console.log(validate.errors); // diagnostics if invalid
9193
Protocol-Commons is the **semantic foundation** of the CommandLayer stack.
9294

9395
---
96+
## Table of Contents
97+
- [Real verbs. Real receipts.](#real-verbs-real-receipts)
98+
- [Quickstart](#quickstart)
99+
- [What Commons enables](#what-commons-enables)
100+
- [Canonical Verbs](#canonical-verbs)
101+
- [Why this exists](#why-this-exists)
102+
- [Overview](#overview)
103+
- [Key Principles](#key-principles)
104+
- [This is not…](#this-is-not)
105+
- [CommandLayer Protocol Stack](#commandlayer-protocol-stack)
106+
- [Status](#status)
107+
- [Repository Structure](#repository-structure)
108+
- [Manifest](#manifest)
109+
- [Immutability & Checksums](#immutability--checksums)
110+
- [Validation](#validation)
111+
- [License](#license)
112+
- [Next Layers](#next-layers)
113+
- [References](#references)
114+
115+
---
116+
94117
## Canonical Verbs
95118

96119
The Commons defines 10 universal actions used across nearly all multi-agent workflows:
@@ -181,26 +204,6 @@ Economics happen in higher layers.
181204

182205
---
183206

184-
## Table of Contents
185-
- [Real verbs. Real receipts.](#real-verbs-real-receipts)
186-
- [Quickstart](#quickstart)
187-
- [What Commons enables](#what-commons-enables)
188-
- [Canonical Verbs](#canonical-verbs)
189-
- [Why this exists](#why-this-exists)
190-
- [Overview](#overview)
191-
- [Key Principles](#key-principles)
192-
- [This is not…](#this-is-not)
193-
- [CommandLayer Protocol Stack](#commandlayer-protocol-stack)
194-
- [Status](#status)
195-
- [Repository Structure](#repository-structure)
196-
- [Manifest](#manifest)
197-
- [Immutability & Checksums](#immutability--checksums)
198-
- [Validation](#validation)
199-
- [License](#license)
200-
- [Next Layers](#next-layers)
201-
- [References](#references)
202-
203-
---
204207
### Key Principles
205208

206209
- Shared semantics for every autonomous agent
@@ -410,4 +413,5 @@ CommandLayer follows a clean separation of concerns:
410413

411414

412415

416+
413417

0 commit comments

Comments
 (0)