Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,21 @@

---

json-record gives you **chronological integrity**: a guarantee that a sequence of blocks has not been altered, reordered, or truncated. It does not enforce authenticity or authorship; it simply ensures the history is intact.
## What json-record is for

json-record stores arbitrary bytes and produces a JSON-compatible record
describing the block: index, timestamp, payloadHash, prevHash, and blockHash.

The payload itself is a Uint8Array. It can contain any bytes: text, JSON,
images, audio, encrypted data, or custom binary formats.

The “json” in json-record refers to the record structure, not the payload.
json-record does not interpret or transform the payload. It only guarantees
integrity and ordering.

json-record gives you **chronological integrity**: a guarantee that a sequence
of blocks has not been altered, reordered, or truncated. It does not enforce
authenticity or authorship; it simply ensures the history is intact.

---

Expand Down Expand Up @@ -89,7 +103,8 @@ json-record does not provide:
- identity
- access control

If you need to prove who created the data, seal the payload with **json-seal** before storing it in the trail.
If you need to prove who created the data, seal the payload with **json-seal**
before storing it in the trail.

json-record stays intentionally minimal.

Expand Down Expand Up @@ -203,7 +218,9 @@ json-record builds on a long lineage of cryptographic integrity primitives:
- Certificate Transparency logs
- Secure audit log research

json-record distills these ideas into a tiny, deterministic, dependency-free primitive designed for local-first apps, PWAs, and in-memory trails. It offers integrity without the complexity.
json-record distills these ideas into a tiny, deterministic, dependency-free
primitive designed for local-first apps, PWAs, and in-memory trails. It offers
integrity without the complexity.

---

Expand Down
19 changes: 19 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ <h1>json-record</h1>
Tamper-evident, hash-linked blocks for apps. Zero dependencies.
</p>

<p class="note">
json-record stores arbitrary bytes and produces a JSON-compatible record
describing the block. The payload itself is a Uint8Array and can contain
any bytes: text, JSON, images, encrypted data, or custom binary formats.
The "json" refers to the record structure, not the payload.
</p>

<p>
json-record is a tiny library for creating hash-linked blocks that detect
any modification to payloads or history. It provides chronological
Expand All @@ -30,6 +37,18 @@ <h2>Why json-record exists</h2>
minimal, deterministic, tamper-evident structure for that purpose.
</p>

<h2>What json-record gives you that other tools do not</h2>

<p>
Databases, CRDTs, and sync engines track state, but they do not guarantee
that the <em>history</em> of that state is intact. json-record provides a
deterministic, hash-linked sequence of blocks that makes any deletion,
insertion, or reordering immediately detectable. It is a portable,
dependency-free integrity primitive that works in browsers, PWAs, mobile
WebViews, and Node without servers, consensus protocols, or blockchain
overhead.
</p>

<h2>Features</h2>
<ul>
<li>Deterministic SHA-256 hashing</li>
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.