From e5c63e787f39cd37fad98f543139dd27f71bdc07 Mon Sep 17 00:00:00 2001 From: Matthias Andreas Benkard Date: Sat, 18 Dec 2021 11:10:47 +0100 Subject: Update README. Change-Id: I4f0fb8917bcc472a3d0c4f0bf4a5b9c9891ba777 --- README.md | 42 +++++++++++++++++++++++++++++++++++++----- src/main/java/module-info.java | 2 +- 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` 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 + + + ... + + + ... + + + eu.mulk.jgvariant + jgvariant-core + 0.1.0 + + + ... + + + ... + + + +### 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. * *

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; -- cgit v1.2.3