From 829bdd97e20bdc3396982c20de9d3d77bdf8ed78 Mon Sep 17 00:00:00 2001 From: Chris Myers Date: Wed, 28 Jan 2026 22:23:08 +0000 Subject: [PATCH] Update docs to describe what json-record is for --- README.md | 23 ++++++++++++++++++++--- docs/index.html | 19 +++++++++++++++++++ package-lock.json | 2 +- 3 files changed, 40 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index acb571e..9ba66f7 100644 --- a/README.md +++ b/README.md @@ -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. --- @@ -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. @@ -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. --- diff --git a/docs/index.html b/docs/index.html index ab28802..480eb4e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -15,6 +15,13 @@

json-record

Tamper-evident, hash-linked blocks for apps. Zero dependencies.

+

+ 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. +

+

json-record is a tiny library for creating hash-linked blocks that detect any modification to payloads or history. It provides chronological @@ -30,6 +37,18 @@

Why json-record exists

minimal, deterministic, tamper-evident structure for that purpose.

+

What json-record gives you that other tools do not

+ +

+ Databases, CRDTs, and sync engines track state, but they do not guarantee + that the history 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. +

+

Features