Skip to content

Commit 2d9d08e

Browse files
committed
docs: update README
1 parent eaa4807 commit 2d9d08e

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ AimDB is not a storage engine. It's a typed data plane where the Rust type *is*
3131

3232
[![AimDB Live Demo](assets/demo.gif)](https://aimdb.dev)
3333

34-
> **[See it running](https://aimdb.dev)** Live weather stations streaming typed contracts across MCU, edge and cloud.
34+
> **[See it running](https://aimdb.dev)** Live weather stations streaming typed contracts across MCU, edge and cloud.
3535
3636
---
3737

@@ -43,7 +43,7 @@ Distributed systems spend most of their complexity budget translating between la
4343
- **The buffer defines how data moves.** No manual queue wiring, no separate transport config.
4444
- **No untyped boundaries.** Capabilities, like streaming, migration, observability and connectors, are unlocked by traits.
4545

46-
[The Next Era of Software Architecture Is Data-First](https://aimdb.dev/blog/data-driven-design)
46+
[The Next Era of Software Architecture Is Data-First](https://aimdb.dev/blog/data-driven-design)
4747

4848
---
4949

@@ -108,7 +108,7 @@ cd aimdb/examples/weather-mesh-demo
108108
docker compose up
109109
```
110110

111-
[Walkthrough in the docs](https://aimdb.dev/docs/getting-started)
111+
[Walkthrough in the docs](https://aimdb.dev/docs/getting-started)
112112

113113
---
114114

@@ -135,13 +135,13 @@ docker compose up
135135

136136
**Connectors that ship today:** MQTT, KNX, WebSocket. Writing your own is one trait impl.
137137

138-
Deep dives: [data contracts](https://aimdb.dev/blog/data-contracts-deep-dive) · [source/tap/transform](https://aimdb.dev/blog/source-tap-transform) · [schema migration](https://aimdb.dev/blog/schema-migration-without-ceremony) · [reactive pipelines](https://aimdb.dev/blog/reactive-pipelines)
138+
Deep dives: [data contracts](https://aimdb.dev/blog/data-contracts-deep-dive) · [source/tap/transform](https://aimdb.dev/blog/source-tap-transform) · [schema migration](https://aimdb.dev/blog/schema-migration-without-ceremony) · [reactive pipelines](https://aimdb.dev/blog/reactive-pipelines)
139139

140140
---
141141

142142
### How the dataflow fits together
143143

144-
A record is written by a `Source`, lands in a typed `Buffer`, and fans out to in-process subscribers (`Tap`) and wire-format bridges (`Link` → connector):
144+
A record is written by a `Source`, lands in a typed `Buffer` and fans out to in-process subscribers (`Tap`) and wire-format bridges (`Link` → connector):
145145

146146
```
147147
Producer Consumers
@@ -219,7 +219,7 @@ See the [MCP server docs](tools/aimdb-mcp/) for Claude Desktop and other editors
219219

220220
## Help wanted
221221

222-
We're a small team building something ambitious. The fastest way to help is to take on a scoped piece of it. Each of these is sized for a few hours and includes file pointers, acceptance criteria, and a place to ask questions:
222+
We're a small team building something ambitious. The fastest way to help is to take on a scoped piece of it. Each of these is sized for a few hours and includes file pointers, acceptance criteria and a place to ask questions:
223223

224224
- [#92`no_std` `Display` for `DbError` should include numeric fields](https://github.com/aimdb-dev/aimdb/issues/92) · 2–3h · core · embedded
225225
- [#93 — Minimal example: `hello-single-latest`](https://github.com/aimdb-dev/aimdb/issues/93) · 2–3h · docs

0 commit comments

Comments
 (0)