Include licence in jar file

Nianna · Jul 14, 2023 · 0b87776 · 0b87776
1 parent a3ed97e
commit 0b87776
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/pom.xml b/pom.xml
@@ -39,6 +39,7 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
         <junit.version>5.9.2</junit.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
     <dependencies>
@@ -58,6 +59,15 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>.</directory>
+                <targetPath>/META-INF</targetPath>
+                <includes>
+                    <include>LICENSE</include>
+                </includes>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

diff --git a/src/main/java/io/github/nianna/api/HyphenatedText.java b/src/main/java/io/github/nianna/api/HyphenatedText.java
@@ -30,19 +30,23 @@
  */
 public record HyphenatedText(List<HyphenatedToken> hyphenatedTokens) {
 
+    /**
+     * Default separator used between tokens
+     */
     public static final String DEFAULT_TOKEN_SEPARATOR = " ";
 
+    /**
+     * Default separator used between syllables of a single token
+     */
     public static final String DEFAULT_SYLLABLE_SEPARATOR = "-";
 
-
     /**
      * @return String representation of hyphenated text. Tokens are separated by space, syllables by hyphen.
      */
     public String read() {
         return read(DEFAULT_TOKEN_SEPARATOR, DEFAULT_SYLLABLE_SEPARATOR);
     }
 
-
     /**
      * @param tokenSeparator separator to be used between tokens
      * @param syllableSeparator  separator to be used between syllables