Skip to content

Commit 806a42d

Browse files
committed
chore: Update README.md
1 parent 1ab60d5 commit 806a42d

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Irokle
22

3-
Irokle is a signed Merkle-DAG operation log for invite-only topics. Application events and membership changes are stored as signed operations; heads, actor clocks, topic state, history, sync summaries, and reducer projections are derived from those operations.
3+
Irokle is a signed Merkle-DAG operation log for invite-only topics. Application events and membership changes are stored as signed operations. The graph of operations can be used to derive current heads, a history of changes, summaries for syncing, and projections.
44

5-
## What It Provides
5+
## Features
66

77
- Signed operations: every event or control change is signed by the peer that authored it.
88
- Topic membership: topics are not public broadcast channels; typed access is gated by the current signed member set.
99
- Deterministic sync: peers exchange summaries, missing operation closures, requests, and signed acknowledgements.
1010
- Bounded fanout: topic replication is capped by `ReplicationPolicy::max_sync_peers` so a node does not sync with every member by default.
1111
- Observability: sync status records expose pending obligations, failure counts, last errors, last success, and per-state counts.
1212
- Storage choices: `MemoryStorage` is available by default; `FjallStorage` is available behind the `fjall` feature.
13-
- Iroh integration: the `iroh` feature syncs over `iroh::Endpoint` using `PeerId`/NodeId dialing.
13+
- Iroh integration: the `iroh` feature syncs over `iroh::Endpoint` using `PeerId`/`NodeId` dialing.
1414

1515
## Minimal Example
1616

@@ -59,7 +59,7 @@ fn main() -> irokle::Result<()> {
5959
}
6060
```
6161

62-
This example uses the transport-neutral sync API directly. Iroh examples use `sync_now(peer_id, topic_id)` instead.
62+
This example uses the transport-neutral sync API directly. Iroh examples can use `sync_now(peer_id, topic_id)` instead.
6363

6464
## Topics And Membership
6565

0 commit comments

Comments
 (0)