Update documentation, site links, README.

io7m-com · May 11, 2024 · cdb23f2 · cdb23f2
1 parent bf7de49
commit cdb23f2
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 7 deletions.
diff --git a/README.in b/README.in
@@ -0,0 +1,30 @@
+
+## mime2045
+
+The `mime2045` package provides functions for parsing RFC 2045 MIME types.
+
+## Features
+
+* RFC 2045 MIME type parsing.
+* High coverage test suite.
+* [OSGi-ready](https://www.osgi.org/).
+* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System).
+* ISC license.
+
+## Usage
+
+Declare MIME types directly:
+
+```
+final var textPlain =
+  MimeType.of("text", "plain");
+```
+
+Parse MIME type strings:
+
+```
+final var parsed =
+  new MimeParsers().parse("text/plain");
+
+assert textPlain.equals(parsed);
+```
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ mime2045
 [![Maven Central](https://img.shields.io/maven-central/v/com.io7m.mime2045/com.io7m.mime2045.svg?style=flat-square)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.io7m.mime2045%22)
 [![Maven Central (snapshot)](https://img.shields.io/nexus/s/com.io7m.mime2045/com.io7m.mime2045?server=https%3A%2F%2Fs01.oss.sonatype.org&style=flat-square)](https://s01.oss.sonatype.org/content/repositories/snapshots/com/io7m/mime2045/)
 [![Codecov](https://img.shields.io/codecov/c/github/io7m-com/mime2045.svg?style=flat-square)](https://codecov.io/gh/io7m-com/mime2045)
-![Java Version](https://img.shields.io/badge/21-java?label=java&color=e6c35c)
+![Java Version](https://img.shields.io/badge/17-java?label=java&color=e65cc3)
 
 ![com.io7m.mime2045](./src/site/resources/mime2045.jpg?raw=true)
 
@@ -14,3 +14,34 @@ mime2045
 | OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/mime2045/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/mime2045/actions?query=workflow%3Amain.linux.temurin.lts)|
 | OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/mime2045/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/mime2045/actions?query=workflow%3Amain.windows.temurin.current)|
 | OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/mime2045/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/mime2045/actions?query=workflow%3Amain.windows.temurin.lts)|
+
+## mime2045
+
+The `mime2045` package provides functions for parsing RFC 2045 MIME types.
+
+## Features
+
+* RFC 2045 MIME type parsing.
+* High coverage test suite.
+* [OSGi-ready](https://www.osgi.org/).
+* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System).
+* ISC license.
+
+## Usage
+
+Declare MIME types directly:
+
+```
+final var textPlain =
+  MimeType.of("text", "plain");
+```
+
+Parse MIME type strings:
+
+```
+final var parsed =
+  new MimeParsers().parse("text/plain");
+
+assert textPlain.equals(parsed);
+```
+
diff --git a/pom.xml b/pom.xml
@@ -28,9 +28,11 @@
   </modules>
 
   <properties>
-    <com.io7m.xstructural.version>1.8.0</com.io7m.xstructural.version>
+    <!-- Configuration. -->
     <io7m.api.previousVersion>1.0.0</io7m.api.previousVersion>
-    <io7m.java.targetJavaVersion>21</io7m.java.targetJavaVersion>
+    <io7m.java.targetJavaVersion>17</io7m.java.targetJavaVersion>
+
+    <!-- Third-party dependencies. -->
     <jqwik.version>1.8.4</jqwik.version>
     <junit.version>5.10.2</junit.version>
   </properties>

diff --git a/src/site/resources/documentation.xml b/src/site/resources/documentation.xml
@@ -2,5 +2,7 @@
 
 <div xmlns="http://www.w3.org/1999/xhtml">
   <h3>User Documentation</h3>
-  <p>No user documentation is currently available.</p>
+  <p>
+    See the <a href="https://www.github.com/io7m-com/mime2045">README</a>.
+  </p>
 </div>
diff --git a/src/site/resources/overview.xml b/src/site/resources/overview.xml
@@ -1,15 +1,15 @@
 <div xmlns="http://www.w3.org/1999/xhtml">
   <p class="shields">
     <a href="https://www.github.com/io7m-com/mime2045/actions?query=workflow%3Amain.linux.temurin.lts">
-      <img src="https://img.shields.io/github/actions/workflow/status/io7m/mime2045/main.linux.temurin.lts.yml"
+      <img src="https://img.shields.io/github/actions/workflow/status/io7m-com/mime2045/main.linux.temurin.lts.yml"
            alt="Build status"/>
     </a>
       <a href="http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.io7m.mime2045%22">
          <img src="https://img.shields.io/maven-central/v/com.io7m.mime2045/com.io7m.mime2045.svg?style=flat-square"
               alt="Maven Central"/>
       </a>
-      <a href="https://codecov.io/gh/io7m/mime2045">
-         <img src="https://img.shields.io/codecov/c/github/io7m/mime2045.svg?style=flat-square"
+      <a href="https://codecov.io/gh/io7m-com/mime2045">
+         <img src="https://img.shields.io/codecov/c/github/io7m-com/mime2045.svg?style=flat-square"
               alt="Codecov"/>
       </a>
   </p>