From 2d5d2cb5fe93b0144dfb26547a5d548f9c1ffceb Mon Sep 17 00:00:00 2001
From: Ronald Brill <rbri@rbri.de>
Date: Sat, 18 Mar 2023 12:09:26 +0100
Subject: [PATCH] more docu

---
 README.md | 78 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 46 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md
index 591f7b0f..a3dfcc56 100644
--- a/README.md
+++ b/README.md
@@ -20,45 +20,29 @@ This made it possible to remove many unneeded parts and dependencies to ensure e
 #### CVE-2022-29546 / CVE-2022-28366
 #### HtmlUnit - NekoHtml Parser suffers from a denial of service vulnerability on versions 2.60.0 and below. A specifically crafted input regarding the parsing of processing instructions leads to heap memory consumption. Please update to at least version 2.62.0.
 
-For maven, you would add:
+## Get it!
 
-    <dependency>
-        <groupId>net.sourceforge.htmlunit</groupId>
-        <artifactId>neko-htmlunit</artifactId>
-        <version>2.70.0</version>
-    </dependency>
-
-### Last CI build
-The latest builds are available from our
-[Jenkins CI build server][2]
+### Maven
 
-[![Build Status](https://jenkins.wetator.org/buildStatus/icon?job=HtmlUnit+-+Neko)](https://jenkins.wetator.org/view/HtmlUnit/job/HtmlUnit%20-%20Neko/)
-
-
-If you use maven please add:
+Add to your `pom.xml`:
 
-    <dependency>
-        <groupId>net.sourceforge.htmlunit</groupId>
-        <artifactId>neko-htmlunit</artifactId>
-        <version>2.71.0-SNAPSHOT</version>
-    </dependency>
+```xml
+<dependency>
+    <groupId>org.htmlunit</groupId>
+    <artifactId>neko-htmlunit</artifactId>
+    <version>3.0.0</version>
+</dependency>
+```
 
-You have to add the sonatype snapshot repository to your pom distributionManagement section also:
+### Gradle
 
-    <repository>
-        <id>OSS Sonatype snapshots</id>
-        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
-        <snapshots>
-            <enabled>true</enabled>
-            <updatePolicy>always</updatePolicy>
-        </snapshots>
-        <releases>
-            <enabled>false</enabled>
-        </releases>
-    </repository>
+Add to your `build.gradle`:
 
+```groovy
+implementation group: 'org.htmlunit', name: 'neko-htmlunit', version: '3.0.0'
+```
 
-## HowTo use NekoHtml
+## HowTo use
 
 ### DOMParser
 
@@ -105,6 +89,36 @@ Using the SAXParser is straigtforward - simple provide your own org.xml.sax.Cont
     parser.parse(in);
 
 
+### Last CI build
+The latest builds are available from our
+[Jenkins CI build server][2]
+
+[![Build Status](https://jenkins.wetator.org/buildStatus/icon?job=HtmlUnit+-+Neko)](https://jenkins.wetator.org/view/HtmlUnit/job/HtmlUnit%20-%20Neko/)
+
+
+If you use maven please add:
+
+    <dependency>
+        <groupId>net.sourceforge.htmlunit</groupId>
+        <artifactId>neko-htmlunit</artifactId>
+        <version>2.71.0-SNAPSHOT</version>
+    </dependency>
+
+You have to add the sonatype snapshot repository to your pom distributionManagement section also:
+
+    <repository>
+        <id>OSS Sonatype snapshots</id>
+        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
+        <snapshots>
+            <enabled>true</enabled>
+            <updatePolicy>always</updatePolicy>
+        </snapshots>
+        <releases>
+            <enabled>false</enabled>
+        </releases>
+    </repository>
+
+
 ## Start NekoHtml Development
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.