aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-18 11:10:47 +0100
committerMatthias Andreas Benkard <code@mail.matthias.benkard.de>2021-12-18 11:10:47 +0100
commite5c63e787f39cd37fad98f543139dd27f71bdc07 (patch)
treebc7e5d4212c5da2f660119d7fbdc488533aa8cc8
parent6e1df9aee2c0301a432f6414be5069263abe63b1 (diff)
Update README.
Change-Id: I4f0fb8917bcc472a3d0c4f0bf4a5b9c9891ba777
-rw-r--r--README.md42
-rw-r--r--src/main/java/module-info.java2
2 files changed, 38 insertions, 6 deletions
diff --git a/README.md b/README.md
index b607610..64bafc6 100644
--- a/README.md
+++ b/README.md
@@ -5,16 +5,48 @@ This library provides a [GVariant][] parser in pure Java.
## Overview
-The foundational class is `Decoder`.
-
-Instances of `Decoder` read a given concrete subtype of `Value` from a
-[ByteBuffer][]. The class also contains factory methods to create
-those instances.
+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.
The various subclasses of `Decoder` together implement the [GVariant
serialization][] specification.
+## Installation
+
+### Usage with Maven
+
+ <project>
+ ...
+
+ <dependencies>
+ ...
+
+ <dependency>
+ <groupId>eu.mulk.jgvariant</groupId>
+ <artifactId>jgvariant-core</artifactId>
+ <version>0.1.0</version>
+ </dependency>
+
+ ...
+ </dependencies>
+
+ ...
+ </project>
+
+
+### Usage with Gradle
+
+ dependencies {
+ ...
+
+ implementation("eu.mulk.jgvariant:jgvariant-core:0.1.0")
+
+ ...
+ }
+
+
## Example
To parse a [GVariant][] value of type `"a(si)"`, which is an array of
diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
index c0debad..4e358d2 100644
--- a/src/main/java/module-info.java
+++ b/src/main/java/module-info.java
@@ -3,7 +3,7 @@
* serialization format.
*
* <p>The {@link eu.mulk.jgvariant.core} package contains the {@link eu.mulk.jgvariant.core.Decoder}
- * type. which forms the foundation of this library.
+ * type, which forms the foundation of this library.
*/
module eu.mulk.jgvariant.core {
requires com.google.errorprone.annotations;