From ee6f2e8845cd5f19bb91fbea3e47341fdd330511 Mon Sep 17 00:00:00 2001
From: Jonas Schaub <44881147+JonasSchaub@users.noreply.github.com>
Date: Mon, 3 Jul 2023 16:50:16 +0200
Subject: [PATCH] Updated readme with link to JavaDoc
---
README.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 0b910cb..af6f6c5 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[![DOI](https://zenodo.org/badge/580826376.svg)](https://zenodo.org/badge/latestdoi/580826376)
+[![DOI](https://zenodo.org/badge/580826376.svg)](https://zenodo.org/badge/latestdoi/580826376) [![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://jonasschaub.github.io/ART2a-Clustering-for-Java/javadoc/)
# ART2a-Clustering-for-Java
Implementation of the ART 2-A fingerprint clustering algorithm in Java.
@@ -28,7 +28,10 @@ one bit fingerprint. And the file named "Count_Fingerprints.txt" contains 6 coun
one count fingerprint.
## Example initialization and usage of ART2a-Clustering-for-Java
-see in "wiki"
+See the wiki of this repository.
+
+## JavaDoc
+The JavaDoc of this library can be found here.
## Installation
This is a Gradle project. In order to use the source code for your own software, download or clone the repository and
@@ -50,6 +53,9 @@ be pre-installed.
* Spotless version 6.19
* [Spotless GitHub repository](https://github.com/diffplug/spotless)
* License: Apache-2.0 license
+* Javadoc-publisher version 2.4
+ * [Javadoc-publisher GitHub repository](https://github.com/MathieuSoysal/Javadoc-publisher.yml)
+ * License: Apache-2.0 license
## References and useful links
**ART 2-A: An adaptive resonance algorithm for rapid category learning and recognition**