Skip to content

Refresh README #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
satabin merged 1 commit into from
Sep 25, 2026
Merged

Refresh README #525

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 14 additions & 6 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Gnieh Diffson
[![Build Status](https://travis-ci.org/gnieh/diffson.png)](https://travis-ci.org/gnieh/diffson)
[![Build Status](https://github.com/gnieh/diffson/workflows/Continuous%20Integration/badge.svg)](https://github.com/gnieh/diffson/actions/workflows/ci.yml)
[![Maven Central](https://img.shields.io/maven-central/v/org.gnieh/diffson-core_2.13)](https://central.sonatype.com/artifact/org.gnieh/diffson-core_2.13)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9892e2c968974ecb951d21969adbadaa)](https://www.codacy.com/app/satabin/diffson?utm_source=github.com&utm_medium=referral&utm_content=gnieh/diffson&utm_campaign=Badge_Grade)
[![Code Coverage](https://codecov.io/github/gnieh/diffson/coverage.svg?branch=master)](https://codecov.io/github/gnieh/diffson?branch=master)
[![Maven Central](https://img.shields.io/maven-central/v/org.gnieh/diffson-core_2.13.svg)](https://maven-badges.herokuapp.com/maven-central/org.gnieh/diffson-core_2.13)
[![Scaladoc](https://javadoc.io/badge/org.gnieh/diffson-core_2.13.svg)](https://javadoc.io/doc/org.gnieh/diffson-core_2.13)

----
Expand All @@ -26,6 +26,7 @@ It also provides methods to compute _diffs_ between two Json values that produce
- [Simple diffs](#simple-diffs)
- [Remembering old values](#remembering-old-values)
- [Json Merge Patches (RFC-7396)](#json-merge-patches-rfc-7396)
- [License](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -35,7 +36,7 @@ Getting Started
This library is published in the [Maven][7] [Central Repository][8].
You can add it to your sbt project by putting this line into your build description:
```scala
libraryDependencies += "org.gnieh" %% f"diffson-$jsonLib" % "4.1.1"
libraryDependencies += "org.gnieh" %% f"diffson-$jsonLib" % "4.7.1"
```

where `jsonLib` is either:
Expand All @@ -47,10 +48,12 @@ where `jsonLib` is either:

These versions are built for Scala 2.12, 2.13, and 3.

Scala.JS is also supported for Scala 2.12, 2.13, and 3.
To use it, add this dependency to your build file:
Scala.js (1.x) and Scala Native (0.5.x) are supported for `core`, `circe`, `play-json`,
`ujson`, and `testkit`, on the same three Scala versions.

For these platforms, add this dependency to your build file:
```scala
libraryDependencies += "org.gnieh" %%% f"diffson-$jsonLib" % "4.1.1"
libraryDependencies += "org.gnieh" %%% f"diffson-$jsonLib" % "4.7.1"
```

Json Library
Expand Down Expand Up @@ -378,6 +381,11 @@ which will create the following Json:
```
which we can easily verify is the same as `json2` modulo reordering of fields.

License
-------

Diffson is licensed under the [Apache License, Version 2.0](LICENSE).

[1]: https://datatracker.ietf.org/doc/html/rfc6901
[2]: https://datatracker.ietf.org/doc/html/rfc6902
[3]: https://github.com/spray/spray-json
Expand Down