From e40bde8e7c7dbd6d1ce68644798363bd8bf59598 Mon Sep 17 00:00:00 2001
From: "jacek.wolniewicz" <jacekwoln@gmail.com>
Date: Thu, 4 Jul 2024 17:40:22 +0200
Subject: [PATCH] - clean up code - rename module Example to examples

---
 {Examples => examples}/pom.xml                             | 2 +-
 .../io/github/jwdeveloper/tiktok/CollectorExample.java     | 0
 .../io/github/jwdeveloper/tiktok/ConnectionExample.java    | 0
 .../io/github/jwdeveloper/tiktok/CustomEventExample.java   | 0
 .../io/github/jwdeveloper/tiktok/CustomMappingExample.java | 0
 .../io/github/jwdeveloper/tiktok/CustomizationExample.java | 0
 .../tiktok/Events_And_Gifts_Testing_Example.java           | 0
 .../java/io/github/jwdeveloper/tiktok/GiftsExample.java    | 0
 .../java/io/github/jwdeveloper/tiktok/ListenerExample.java | 0
 .../java/io/github/jwdeveloper/tiktok/ProxyExample.java    | 0
 .../java/io/github/jwdeveloper/tiktok/RecorderExample.java | 0
 future.md                                                  | 7 +++++++
 pom.xml                                                    | 2 +-
 .../io/github/jwdeveloper/tiktok/EventsInfoGenerator.java  | 1 -
 .../java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java | 1 -
 15 files changed, 9 insertions(+), 4 deletions(-)
 rename {Examples => examples}/pom.xml (98%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/ConnectionExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/CustomEventExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/CustomMappingExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/CustomizationExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/Events_And_Gifts_Testing_Example.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/GiftsExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/ListenerExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/ProxyExample.java (100%)
 rename {Examples => examples}/src/main/java/io/github/jwdeveloper/tiktok/RecorderExample.java (100%)
 create mode 100644 future.md

diff --git a/Examples/pom.xml b/examples/pom.xml
similarity index 98%
rename from Examples/pom.xml
rename to examples/pom.xml
index 8d43913..2e17d14 100644
--- a/Examples/pom.xml
+++ b/examples/pom.xml
@@ -46,7 +46,7 @@
 
     <modelVersion>4.0.0</modelVersion>
 
-    <artifactId>Examples</artifactId>
+    <artifactId>examples</artifactId>
     <dependencies>
         <dependency>
             <groupId>io.github.jwdeveloper.tiktok</groupId>
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/ConnectionExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/ConnectionExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/ConnectionExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/ConnectionExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CustomEventExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/CustomEventExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/CustomEventExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/CustomEventExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CustomMappingExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/CustomMappingExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/CustomMappingExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/CustomMappingExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CustomizationExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/CustomizationExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/CustomizationExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/CustomizationExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/Events_And_Gifts_Testing_Example.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/Events_And_Gifts_Testing_Example.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/Events_And_Gifts_Testing_Example.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/Events_And_Gifts_Testing_Example.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/GiftsExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/GiftsExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/GiftsExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/GiftsExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/ListenerExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/ListenerExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/ListenerExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/ListenerExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/ProxyExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/ProxyExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/ProxyExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/ProxyExample.java
diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/RecorderExample.java b/examples/src/main/java/io/github/jwdeveloper/tiktok/RecorderExample.java
similarity index 100%
rename from Examples/src/main/java/io/github/jwdeveloper/tiktok/RecorderExample.java
rename to examples/src/main/java/io/github/jwdeveloper/tiktok/RecorderExample.java
diff --git a/future.md b/future.md
new file mode 100644
index 0000000..4f8f9fc
--- /dev/null
+++ b/future.md
@@ -0,0 +1,7 @@
+Future plans:
+
+[ ] Publish project to Maven repository instead of JITPACK
+[ ] Dynamically generates readme.md when new version is released
+[ ] Covers all possible classes from Client module  with unit test
+[ ] Add tests check to GitHub publish action
+[ ] Generates documentation based on API module and publish it with GitHub pages
diff --git a/pom.xml b/pom.xml
index 07e272e..886687c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -11,7 +11,7 @@
     <modules>
         <module>API</module>
         <module>Client</module>
-        <module>Examples</module>
+        <module>examples</module>
         <module>tools-readme</module>
 
         <module>extension-recorder</module>
diff --git a/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java
index eb6f398..6ad3c6b 100644
--- a/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java
+++ b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java
@@ -41,7 +41,6 @@ public class EventsInfoGenerator {
         System.out.println(res);
     }
 
-
     public String run() {
         var events = getEventsDtos();
         var builder = new StringBuilder();
diff --git a/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java
index 19413c6..04856a8 100644
--- a/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java
+++ b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java
@@ -27,7 +27,6 @@ public class ReadmeGenerator {
     public static void main(String[] args) {
         var generator = new ReadmeGenerator();
         generator.generate();
-
     }
 
     public void generate() {