From df1f52e3257f47b8640c498ef5bc06909df8e272 Mon Sep 17 00:00:00 2001 From: rUv Date: Fri, 27 Feb 2026 03:38:52 +0000 Subject: [PATCH] docs: minor README polish for replication and rvf-crypto Co-Authored-By: claude-flow --- crates/ruvector-replication/README.md | 9 +++++---- crates/rvf/rvf-crypto/README.md | 9 ++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/crates/ruvector-replication/README.md b/crates/ruvector-replication/README.md index 974ff70c2..778197127 100644 --- a/crates/ruvector-replication/README.md +++ b/crates/ruvector-replication/README.md @@ -7,10 +7,6 @@ **Multi-master vector replication with quorum writes, vector clocks, and automatic conflict resolution.** -```toml -ruvector-replication = "0.1.1" -``` - 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. | | 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 ## Quick Start +```toml +[dependencies] +ruvector-replication = "0.1.1" +``` + ```rust use ruvector_replication::{Replicator, ReplicationConfig, ConsistencyLevel}; diff --git a/crates/rvf/rvf-crypto/README.md b/crates/rvf/rvf-crypto/README.md index f559ba73a..e4f6d80a8 100644 --- a/crates/rvf/rvf-crypto/README.md +++ b/crates/rvf/rvf-crypto/README.md @@ -5,6 +5,10 @@ **Tamper-proof hashing and signing for every RVF segment -- SHA-3 digests, Ed25519 signatures, and lineage witness chains.** +```toml +rvf-crypto = "0.1" +``` + 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. | | 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. ` ## Quick Start -```toml -[dependencies] -rvf-crypto = "0.1" -``` - ```rust use rvf_crypto::lineage::{lineage_record_to_bytes, lineage_record_from_bytes, verify_lineage_chain}; use rvf_types::{LineageRecord, DerivationType, FileIdentity};