Skip to content

Commit 3abb633

Browse files
authored
Update README.md
1 parent 5ded254 commit 3abb633

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1-
2-
> [!IMPORTANT]
3-
> Your feedback is essential to the improvement of this library. Please share any concerns, primary use cases, areas for enhancement, or challenges you have encountered. Your insights help refine and optimize the library to better meet user needs. Thank you for your time and contributions.
4-
51
# Iridium CBOR-LD
62

7-
Iridium CBOR-LD is a Java implementation of [CBOR-LD 1.0](https://json-ld.github.io/cbor-ld-spec/), a compact binary format for Linked Data.
3+
CBOR-LD is a **self-describing** binary format that encodes Linked Data expressed in JSON-LD into a compact form. Its primary purpose is to compress the verbose textual representation of JSON-LD into just a few bytes; small enough to embed in a QR code, barcode, or any other constrained medium.
84

9-
## ✨ Features
10-
11-
- 🔄 Semantic compression and decompression
12-
- ⚙️ Configurable API for flexible integration
13-
- 🧱 Support for custom document dictionaries and builders
14-
- 📦 Integration with [Verifiable Credential Barcodes](https://w3c-ccg.github.io/vc-barcodes/)
5+
Compression is achieved through **semantic compaction** by relying on shared semantics. The result can always be expanded back into full JSON-LD without loss of meaning.
156

7+
The CBOR-LD format makes Linked Data efficient to store, transmit, and embed in environments where space and bandwidth are limited, while retaining semantic interoperability with the wider Linked Data ecosystem.
168

17-
### Status
9+
Iridium CBOR-LD provides a full implementation of the [CBOR-LD 1.0 specification](https://json-ld.github.io/cbor-ld-spec/), including support for custom dictionaries and integration with Verifiable Credential Barcodes.
1810

1911
[![Java 17 CI](https://github.com/filip26/iridium-cbor-ld/actions/workflows/java17-push.yml/badge.svg)](https://github.com/filip26/iridium-cbor-ld/actions/workflows/java17-push.yml)
2012
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/07fd47ee8fa64d68a47cc83365fa07d6)](https://app.codacy.com/gh/filip26/iridium-cbor-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
2113
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/07fd47ee8fa64d68a47cc83365fa07d6)](https://app.codacy.com/gh/filip26/iridium-cbor-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
14+
[![javadoc](https://javadoc.io/badge2/com.apicatalog/iridium-cbor-ld/javadoc.svg)](https://javadoc.io/doc/com.apicatalog/iridium-cbor-ld)
2215
[![Maven Central](https://img.shields.io/maven-central/v/com.apicatalog/iridium-cbor-ld.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:com.apicatalog%20AND%20a:iridium-cbor-ld)
2316
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2417

18+
## ✨ Features
19+
20+
- 🔄 Semantic compression and decompression
21+
- ⚙️ Configurable API for flexible integration
22+
- 🧱 Support for custom document dictionaries and builders
23+
- 📦 Integration with [Verifiable Credential Barcodes](https://w3c-ccg.github.io/vc-barcodes/)
2524

2625
## CLI
2726
[LD-CLI](https://github.com/filip26/ld-cli) is a command line utility for Ubuntu, Mac and Windows.
@@ -178,10 +177,6 @@ Add JSON-P provider, if it is not on the classpath already.
178177
</dependency>
179178
```
180179

181-
## Documentation
182-
183-
[![javadoc](https://javadoc.io/badge2/com.apicatalog/iridium-cbor-ld/javadoc.svg)](https://javadoc.io/doc/com.apicatalog/iridium-cbor-ld)
184-
185180
## Contributing
186181

187182
All PR's welcome!
@@ -213,5 +208,5 @@ Fork and clone the project repository.
213208

214209
## Commercial Support
215210

216-
Commercial support is available at filip26@gmail.com
217-
211+
Commercial support and consulting are available.
212+
For inquiries, please contact: filip26@gmail.com

0 commit comments

Comments
 (0)