Skip to content

Commit ba0a978

Browse files
committed
docs(readme): complete Phase 1 runtime platform README
Runtime-today table, hosted Cloud boundary, platform direction without overpromising; packages as implementation layer; loopengine.io as canonical docs.
1 parent a3d5191 commit ba0a978

1 file changed

Lines changed: 54 additions & 44 deletions

File tree

README.md

Lines changed: 54 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,29 @@ Loop Engine is an open governed operational runtime platform for AI-assisted ent
1313
Loop Engine connects AI providers, communication channels, and enterprise systems through decision loops.
1414

1515
Every transition through a loop:
16+
1617
- Names the actor responsible (human, automation, or AI agent)
1718
- Evaluates guard policies before allowing the action
18-
- Attaches structured evidence - what information the actor used
19+
- Attaches structured evidence what information the actor used
1920
- Emits an immutable event with full attribution
2021

2122
This creates a decision record produced at runtime, not reconstructed afterward.
2223

24+
## What exists today
25+
26+
Loop Engine is an **OSS operational substrate** you run in your environment — local-first, developer-operable, governance-native.
27+
28+
| Capability | Status |
29+
| --- | --- |
30+
| Decision loop runtime (`@loop-engine/sdk`, `@loop-engine/runtime`) | Shipped |
31+
| Guards, actors, events, signals (core primitives) | Shipped |
32+
| Provider adapters (Anthropic, OpenAI, Gemini, Grok, Perplexity tool path) | Shipped |
33+
| Persistence adapters (memory, Postgres, Kafka) | Shipped |
34+
| Routing / human surfaces (OpenClaw, PagerDuty, Vercel AI SDK patterns) | Shipped |
35+
| Observability timelines and replay | Shipped |
36+
37+
Install one SDK entrypoint, add adapters for your stack, define loops in YAML or TypeScript. Full taxonomy and guides live on **[loopengine.io](https://loopengine.io)** — the canonical documentation surface for this runtime.
38+
2339
## Why Loop Engine?
2440

2541
AI systems make recommendations. Humans approve on channels they already use. Enterprise systems execute side effects. Loop Engine governs what happens between them — who may transition, under which guards, with what evidence.
@@ -36,7 +52,9 @@ Integrations (enterprise systems)
3652
Evidence + learning
3753
```
3854

39-
Loop Engine is not a workflow engine, Slack bot, or generic integration platform. It is governance substrate for AI-assisted operations — local-first, developer-operable, Apache-2.0.
55+
Loop Engine is **not** a workflow engine, Slack bot, or generic integration platform. It is governance substrate for AI-assisted operations.
56+
57+
**Workflows define the path. Loops govern the transitions.** Durable orchestrators (Temporal, n8n, application code) may execute approved work; Loop Engine decides whether state may change and records evidence first.
4058

4159
## Quick Start
4260

@@ -100,63 +118,55 @@ await engine.transition({
100118
})
101119
```
102120

103-
## Packages
104-
105-
| Package | Description |
106-
|---|---|
107-
| [`@loop-engine/sdk`](packages/sdk) | Main SDK - start here |
108-
| [`@loop-engine/runtime`](packages/runtime) | Loop lifecycle and transitions |
109-
| [`@loop-engine/observability`](packages/observability) | Timeline and replay |
110-
| [`@loop-engine/adapter-memory`](packages/adapter-memory) | In-memory storage |
111-
| [`@loop-engine/adapter-postgres`](packages/adapters/postgres) | PostgreSQL storage |
112-
| [`@loop-engine/adapter-kafka`](packages/adapters/kafka) | Kafka event streaming |
113-
| [`@loop-engine/adapter-anthropic`](packages/adapter-anthropic) | Claude AI actor |
114-
| [`@loop-engine/adapter-openai`](packages/adapter-openai) | OpenAI AI actor |
115-
| [`@loop-engine/adapter-grok`](packages/adapter-grok) | Grok (xAI) AI actor |
116-
| [`@loop-engine/adapter-gemini`](packages/adapter-gemini) | Gemini AI actor |
117-
| [`@loop-engine/adapter-perplexity`](packages/adapter-perplexity) | Perplexity Sonar (`ToolAdapter`, citations) |
118-
| [`@loop-engine/adapter-openclaw`](packages/adapter-openclaw) | OpenClaw integration |
119-
| [`@loop-engine/adapter-commerce-gateway`](packages/adapter-commerce-gateway) | Commerce Gateway |
120-
| [`@loop-engine/adapter-pagerduty`](packages/adapter-pagerduty) | PagerDuty incidents |
121-
| [`@loop-engine/adapter-vercel-ai`](packages/adapter-vercel-ai) | Vercel AI SDK |
122-
123-
Core primitives are bundled in `@loop-engine/sdk`. Internal monorepo-only packages for contributors are:
124-
`core`, `dsl`, `guards`, `actors`, `events`, and `signals`.
121+
## npm packages (implementation layer)
122+
123+
`@loop-engine/*` packages implement the runtime — start with [`@loop-engine/sdk`](packages/sdk). Adapters are optional by surface:
124+
125+
| Layer | Packages |
126+
| --- | --- |
127+
| Runtime core | `sdk`, `runtime`, `guards`, `actors`, `events`, `signals` |
128+
| Providers | `adapter-anthropic`, `adapter-openai`, `adapter-gemini`, `adapter-grok`, `adapter-perplexity` |
129+
| Channels / routing | `adapter-openclaw`, `adapter-vercel-ai`, `adapter-pagerduty` |
130+
| Integrations | `adapter-postgres`, `adapter-kafka`, `adapter-http`, `adapter-commerce-gateway`, `adapter-memory` |
131+
132+
Contributor-only monorepo packages: `core`, `dsl`, and related internals bundled through `sdk` for app developers.
125133

126134
## Documentation
127135

128-
Canonical documentation lives at **[loopengine.io](https://loopengine.io)** (runtime, taxonomy, examples, self-host).
136+
**Canonical documentation:** **[loopengine.io/docs](https://loopengine.io/docs)** runtime model, taxonomy, examples, and self-host paths. This repository README is a GitHub entrypoint; do not treat the package table above as the product story.
129137

130138
- [Quick Start](https://loopengine.io/docs/getting-started/quick-start)
131-
- [Core Concepts](https://loopengine.io/docs/core-concepts)
132-
- [Examples](https://loopengine.io/docs/examples)
139+
- [Architecture](https://loopengine.io/docs/getting-started/architecture)
133140
- [Integrations](https://loopengine.io/docs/integrations)
134-
- [Perplexity Sonar & Computer (OSS)](docs/integrations-perplexity.md)
141+
- [Examples](https://loopengine.io/docs/examples)
135142

136-
## Examples
143+
## Loop Engine Cloud (hosted boundary)
144+
145+
**Loop Engine** (this repo) is the open runtime you self-host.
146+
147+
**Loop Engine Cloud** is Better Data’s hosted governance control plane — multi-tenant runtime, connectors, and API keys at [loops.betterdata.co](https://loops.betterdata.co). Contract and operational details: [loopengine.io/docs/integrations/loop-engine-cloud-api](https://loopengine.io/docs/integrations/loop-engine-cloud-api).
148+
149+
We do not claim feature parity between every OSS adapter and Cloud connectors in this README; see hosted docs for what is available in your tenant.
137150

138-
Runnable examples in [github.com/loopengine/loop-examples](https://github.com/loopengine/loop-examples):
151+
## Platform direction
139152

140-
- Expense Approval - human-only approval gate
141-
- AI Replenishment - Claude + OpenAI as governed actors
142-
- Demand Signal - rule-based loop triggering
143-
- Postgres Persistence - production storage adapter
144-
- Event Streaming - Kafka event pipeline
153+
Roadmap themes (not delivery commitments): richer runtime taxonomy docs on loopengine.io, expanded channel adapters, and deeper hosted connector coverage. We avoid promising undelivered surfaces (e.g. multi-service compose stacks or studio products) in OSS copy — direction is shared on [loopengine.io/changelog](https://loopengine.io/docs/changelog) and GitHub discussions.
154+
155+
## Examples
156+
157+
Reference walkthroughs on [loopengine.io/docs/examples](https://loopengine.io/docs/examples). The [loop-examples](https://github.com/loopengine/loop-examples) repository is being brought up to match current SDK APIs — verify runnable status before citing copy-paste flows.
145158

146159
## Contributing
147160

148-
See [CONTRIBUTING.md](CONTRIBUTING.md). Open issues and RFCs at [github.com/loopengine/loop-engine/discussions](https://github.com/loopengine/loop-engine/discussions).
161+
See [CONTRIBUTING.md](CONTRIBUTING.md). RFCs and discussions: [github.com/loopengine/loop-engine/discussions](https://github.com/loopengine/loop-engine/discussions).
149162

150-
## Provenance and package trust
163+
## Provenance
151164

152165
- **Canonical repository:** https://github.com/loopengine/loop-engine
153-
- **Maintainer organization:** Better Data, Inc. (https://betterdata.co)
154-
- **Package family:** `@loop-engine/*` packages in `packages/`
155-
- **Issue tracker:** https://github.com/loopengine/loop-engine/issues
156-
- **Documentation site:** https://loopengine.io
166+
- **Maintainer:** Better Data, Inc. — https://betterdata.co
167+
- **Documentation:** https://loopengine.io
168+
- **Issues:** https://github.com/loopengine/loop-engine/issues
157169

158170
## License
159171

160-
Apache-2.0 - see [LICENSE](LICENSE) for details.
161-
162-
Created and maintained by [Better Data](https://betterdata.co).
172+
Apache-2.0 — see [LICENSE](LICENSE).

0 commit comments

Comments
 (0)