fix: add documentation

triplem · Dec 23, 2024 · c34b18c · c34b18c
1 parent 31d6ede
commit c34b18c
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,6 +3,15 @@
 
 # khol
 
-A pure kotlin implementation for the Holiday Calculation.
+A kotlin implementation for the caluclation of Holidays.
+
+## Usage
+
+The central entry point is the class KHol, which has to be constructed with HolidayDeclarations. These declarations 
+are usually constructed based on Countries (eg. Germany or Belgium). 
 
 https://central.sonatype.org/publish/requirements/gpg/#signing-a-file
+
+
+https://central.sonatype.com/artifact/org.javafreedom/khol
+pkg:maven/org.javafreedom/khol@1.0.1