aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-28 01:31:56 +0100
committerMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-28 01:31:56 +0100
commitaa29484fe74aa2954df35c35306562404043daa9 (patch)
tree830e9f4489e4ba10b62f8eddb3a7f017b64aa0ae /README.md
parent329168c9f3b1e23f440f0c39fca421e1e226c391 (diff)
README: Add module overview.
Change-Id: I8c4701e8d4561940025165dd3beb448e3443de36
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 39d39e3..f1a2d05 100644
--- a/README.md
+++ b/README.md
@@ -5,13 +5,16 @@ This library provides a [GVariant][] parser in pure Java.
## Overview
-Instances of `Decoder<T>` read a given type of GVariant-encoded value
-from a [ByteBuffer][]. The class also contains factory methods to
-acquire those instances.
+`jgvariant-core` provides `Decoder<T>`, which read a given type of
+GVariant-encoded value from a [ByteBuffer][]. The class also contains
+factory methods to acquire those instances.
The various subclasses of `Decoder` together implement the [GVariant
serialization][] specification.
+`jgvariant-ostree` provides instances of `Decoder<T>` for various
+[GVariant][] types used in [OSTree][] repositories.
+
## Example
@@ -89,4 +92,5 @@ pairs of [String][] and `int`, you can use the following code:
[ByteBuffer]: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html
[GVariant]: https://docs.gtk.org/glib/struct.Variant.html
[GVariant serialization]: https://people.gnome.org/~desrt/gvariant-serialisation.pdf
+[OSTree]: https://ostreedev.github.io/ostree/
[String]: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html