From cf79d3c3fd2df2f8e15311a6610078530ec36102 Mon Sep 17 00:00:00 2001
From: JoshiCodes <55353244+JoshiCodes@users.noreply.github.com>
Date: Fri, 24 Jan 2025 23:51:12 +0100
Subject: [PATCH] updated the pom.xml to contain javadocs plugin & created the
 README.md

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 pom.xml   | 39 ++++++++++++++++++++++++++++++++++++++-
 2 files changed, 88 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eb36eb1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+<div align="center">
+
+# ☕ JavaShock
+## OpenShock Wrapper for Java
+
+</div>
+
+> [!Note]
+> 
+> I am not affiliated with OpenShock or any of its developers.
+
+Obviously, you need a [OpenShock](https://openshock.org) account with API Token to use this wrapper.
+
+## Installation
+<img src="https://repo.joshicodes.de/api/badge/latest/releases/de/joshicodes/JavaShock?prefix=v&name=Version">
+
+To use this Wrapper, you need to add the following repository and dependency to your `pom.xml` file.
+Replace `VERSION` with the latest version seen above or found [here](https://github.com/JoshiCodes/JavaShock/releases).
+
+```xml
+<repositories>
+    <repository>
+        <id>joshicodes-de-releases</id>
+        <name>JoshiCodes Repository</name>
+        <url>https://repo.joshicodes.de/releases</url>
+    </repository>
+</repositories>
+```
+
+```xml
+<dependencies>
+    <dependency>
+        <groupId>de.joshicodes</groupId>
+        <artifactId>JavaShock</artifactId>
+        <version>VERSION</version>
+    </dependency>
+</dependencies>
+```
+## Usage
+To use JavaShock, you need to create a new instance with your API Token.
+You can create an API Token [here](https://openshock.app/#/dashboard/tokens).
+
+```java
+final JavaShock shock = new JavaShock("TOKEN-HERE");
+// or if you have a custom API URL:
+final JavaShock shock = new JavaShock("TOKEN-HERE", "https://api.openshock.app");
+// If no URL is provided, the default URL is used.
+```
+
+Everything from here on now is pretty self-explanatory. <br>
diff --git a/pom.xml b/pom.xml
index 730e785..e1db215 100644
--- a/pom.xml
+++ b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>de.joshicodes</groupId>
     <artifactId>JavaShock</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>1.0</version>
 
     <properties>
         <maven.compiler.source>17</maven.compiler.source>
@@ -14,6 +14,43 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.5.0</version>
+                <configuration>
+                    <source>17</source>
+                    <doclint>none</doclint>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>release</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+    <distributionManagement>
+        <repository>
+            <id>joshicodes-de</id>
+            <name>JoshiCodes Repository</name>
+            <url>https://repo.joshicodes.de/releases</url>
+        </repository>
+        <snapshotRepository>
+            <id>joshicodes-de-snapshots</id>
+            <name>JoshiCodes Snapshots Repository</name>
+            <url>https://repo.joshicodes.de/snapshots</url>
+        </snapshotRepository>
+    </distributionManagement>
+
     <dependencies>
         <dependency>
             <groupId>com.google.code.gson</groupId>