bedrock-kv / bedrock / b3fdbe96d9f278d30b1c91940d6406f08a6c275a
82%

DEFAULT BRANCH: develop
Ran
Jobs 1
Files 209
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 75.867% (-0.04%) from 75.904%
b3fdbe96d9f278d30b1c91940d6406f08a6c275a

push

github

web-flow 
Rewrite README to tell the Bedrock story (#147)

## Why

The README led with durability-mode defaults and MinIO test setup — the
merge notes of the most recent initiative — and never said what Bedrock
*is*. A newcomer got one vague sentence, no code, and config trivia.

## What

A first-contact rewrite built on three pillars:

1. **The FoundationDB lineage** — the unbundled sequencer/log/storage
transaction architecture, strict serializability, optimistic MVCC —
named explicitly, since it locates the project instantly for the right
audience (and the livebook already credits FDB's tutorial).
2. **Object-storage-native durability** — the actual novel bit: WAL as a
seconds-deep buffer, byte-identical replica chunks, self-trimming logs,
restarts that replay only the tail. Drawn directly from
`guides/durability-foundation.md`.
3. **Pure BEAM / embedded** — add a dep, join your supervision tree, no
external database fleet.

Structure: hero pitch → code-first example (cluster/repo/transact,
verified against the actual `Repo` API) → livebook badge with context →
Why Bedrock → life-of-a-write → object storage & production config
(demoted from the top) → three-tier documentation map → status →
dev/testing → license.

All factual claims were cross-checked against `lib/` and the guides
(which were themselves fact-checked against the code this week).
Notably: `Repo.get` returns a bare value (the old quick-read `fetch`
example doesn't exist on `Repo`).

## Notes for review

- "converges in under a second" restart claim is carried over from the
durability guide's narrative; happy to soften if we'd rather not commit
to it in the README.
- Added a Hex version badge and an explicit MIT license section.

6061 of 7989 relevant lines covered (75.87%)

1089.09 hits per line

Coverage Regressions

Lines Coverage ∆ File
3
70.11
-3.45% lib/bedrock/data_plane/resolver/tree.ex
Jobs
ID Job ID Ran Files Coverage
1 b3fdbe96d9f278d30b1c91940d6406f08a6c275a.1 209
75.87
GitHub Action Run
Source Files on build b3fdbe96d9f278d30b1c91940d6406f08a6c275a