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
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,15 @@ const { diffDelta, applyDelta, revertDelta } = require('json-diff-ts');

## What is JSON Delta?

[JSON Delta](https://github.com/ltwlf/json-delta-format) is a specification for representing atomic changes to JSON documents. json-diff-ts is the originating implementation from which the spec was derived. A Python implementation is also available: [json-delta-py](https://github.com/ltwlf/json-delta-py).
[JSON Delta](https://github.com/ltwlf/json-delta-format) is a specification for representing atomic changes to JSON documents. json-diff-ts is the originating implementation from which the spec was derived.

```text
json-delta-format (specification)
├── json-diff-ts (TypeScript implementation) ← this package
└── json-delta-py (Python implementation)
```

The specification defines the wire format. Each language implementation produces and consumes compatible deltas.

A delta is a self-describing JSON document you can store, transmit, and consume in any language:

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "json-diff-ts",
"version": "5.0.0-alpha.0",
"version": "5.0.0-alpha.1",
"description": "Modern TypeScript JSON diff library - Zero dependencies, high performance, ESM + CommonJS support. Calculate and apply differences between JSON objects with advanced features like key-based array diffing, JSONPath support, and atomic changesets.",
"main": "./dist/index.cjs",
"module": "./dist/index.js",
Expand Down
Loading