Skip to content

Commit 6d6455f

Browse files
committed
docs: minor README polish for replication and rvf-crypto
Co-Authored-By: claude-flow <ruv@ruv.net>
1 parent 53a567f commit 6d6455f

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

crates/ruvector-replication/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@
77

88
**Multi-master vector replication with quorum writes, vector clocks, and automatic conflict resolution.**
99

10-
```toml
11-
ruvector-replication = "0.1.1"
12-
```
13-
1410
When your vector database runs on more than one node, you need a way to keep data in sync without losing writes or slowing down queries. ruvector-replication handles that: it replicates vectors across nodes, resolves conflicts automatically, and lets you trade off consistency versus speed per-write. It plugs into the [RuVector](https://github.com/ruvnet/ruvector) ecosystem alongside Raft consensus and auto-sharding.
1511

1612
| | Single-node vector DB | ruvector-replication |
@@ -24,6 +20,11 @@ When your vector database runs on more than one node, you need a way to keep dat
2420

2521
## Quick Start
2622

23+
```toml
24+
[dependencies]
25+
ruvector-replication = "0.1.1"
26+
```
27+
2728
```rust
2829
use ruvector_replication::{Replicator, ReplicationConfig, ConsistencyLevel};
2930

crates/rvf/rvf-crypto/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
**Tamper-proof hashing and signing for every RVF segment -- SHA-3 digests, Ed25519 signatures, and lineage witness chains.**
77

8+
```toml
9+
rvf-crypto = "0.1"
10+
```
11+
812
Every operation on an RVF file gets recorded in a cryptographic witness chain. `rvf-crypto` provides the primitives that make this possible: SHA-3 (SHAKE-256) content hashing for segment identity, Ed25519 digital signatures for provenance, and lineage verification functions that ensure no record in the chain has been altered. If you are building tools that read, write, or transform `.rvf` files, this crate handles all the cryptography so you do not have to.
913

1014
| | rvf-crypto | Manual hashing + signing | No integrity checks |
@@ -16,11 +20,6 @@ Every operation on an RVF file gets recorded in a cryptographic witness chain. `
1620

1721
## Quick Start
1822

19-
```toml
20-
[dependencies]
21-
rvf-crypto = "0.1"
22-
```
23-
2423
```rust
2524
use rvf_crypto::lineage::{lineage_record_to_bytes, lineage_record_from_bytes, verify_lineage_chain};
2625
use rvf_types::{LineageRecord, DerivationType, FileIdentity};

0 commit comments

Comments
 (0)