|
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 | | -
|
5 | 1 | # Iridium CBOR-LD |
6 | 2 |
|
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. |
8 | 4 |
|
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. |
15 | 6 |
|
| 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. |
16 | 8 |
|
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. |
18 | 10 |
|
19 | 11 | [](https://github.com/filip26/iridium-cbor-ld/actions/workflows/java17-push.yml) |
20 | 12 | [](https://app.codacy.com/gh/filip26/iridium-cbor-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) |
21 | 13 | [](https://app.codacy.com/gh/filip26/iridium-cbor-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage) |
| 14 | +[](https://javadoc.io/doc/com.apicatalog/iridium-cbor-ld) |
22 | 15 | [](https://search.maven.org/search?q=g:com.apicatalog%20AND%20a:iridium-cbor-ld) |
23 | 16 | [](https://opensource.org/licenses/Apache-2.0) |
24 | 17 |
|
| 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/) |
25 | 24 |
|
26 | 25 | ## CLI |
27 | 26 | [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. |
178 | 177 | </dependency> |
179 | 178 | ``` |
180 | 179 |
|
181 | | -## Documentation |
182 | | - |
183 | | -[](https://javadoc.io/doc/com.apicatalog/iridium-cbor-ld) |
184 | | - |
185 | 180 | ## Contributing |
186 | 181 |
|
187 | 182 | All PR's welcome! |
@@ -213,5 +208,5 @@ Fork and clone the project repository. |
213 | 208 |
|
214 | 209 | ## Commercial Support |
215 | 210 |
|
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