@westonkd/sprint 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -3,8 +3,10 @@
3
3
  A React component library for products that people and AI agents both use. Sprint components
4
4
  look and behave like any other interface, and can describe themselves to an agent on request.
5
5
 
6
- Status: experimental. A full catalog of components on top of the agent runtime, verified in jsdom
7
- and normal browsers; no real WebMCP implementation has accepted a descriptor yet.
6
+ Status: experimental and pre-1.0, published to npm as `@westonkd/sprint`. A full catalog of
7
+ components on top of the agent runtime, verified in jsdom and normal browsers; no real WebMCP
8
+ implementation has accepted a descriptor yet. Until 1.0, a minor version may carry breaking
9
+ changes, and `CHANGELOG.md` marks each one.
8
10
 
9
11
  ## What a Sprint component does
10
12
 
@@ -70,7 +72,8 @@ generated entirely from `agent-manifest.json` — props, state attributes, tool
70
72
  code snippet come from the same metadata an agent reads. Each example can be toggled between the
71
73
  human and agent view, individually or a whole page at once.
72
74
 
73
- Four written guides sit alongside them:
75
+ Four written guides sit alongside them, plus an "Every component" page that renders the whole
76
+ catalog at once:
74
77
 
75
78
  - **WebMCP** — the platform API: both forms, availability, hard limits, and security.
76
79
  - **Integration philosophy** — the decisions behind how Sprint uses it, and what each costs.
@@ -108,8 +111,12 @@ scripts/ manifest generation, build output checks
108
111
 
109
112
  ## Consuming it
110
113
 
111
- React 19 and TypeScript, no runtime dependencies. Not published to npm yet. Once it is, the
112
- package name is `@westonkd/sprint`:
114
+ React 19 and TypeScript, with no runtime dependencies; `react` and `react-dom` 19 are peer
115
+ dependencies.
116
+
117
+ ```bash
118
+ npm install @westonkd/sprint
119
+ ```
113
120
 
114
121
  ```tsx
115
122
  import { Button, SprintProvider } from "@westonkd/sprint";
@@ -123,6 +130,10 @@ import manifest from "@westonkd/sprint/agent-manifest.json" with { type: "json"
123
130
  Wrap your app in `SprintProvider` to register the page-level `list-page-regions` and `read-region`
124
131
  tools. Components work without it.
125
132
 
133
+ Sprint works under a strict `style-src` Content Security Policy: no component writes a `style`
134
+ attribute for a documented value. The one escape hatch is an off-scale length passed to `Stack`'s
135
+ `min` or `Table`'s column `width`, which falls back to an inline style and says so in its docs.
136
+
126
137
  ## WebMCP
127
138
 
128
139
  Tools use the [web platform WebMCP API](https://developer.chrome.com/docs/ai/webmcp)