From b63900b8880d2cbb4952e3197e1eb127baab557e Mon Sep 17 00:00:00 2001
From: bernd32 <bernd32@users.noreply.github.com>
Date: Sun, 15 Dec 2019 19:40:43 +0500
Subject: [PATCH] pom.xml and README.md update

---
 .gitignore |  6 +++++-
 README.md  | 38 ++++++++++++++++++++++++++++----------
 pom.xml    | 20 ++++++--------------
 3 files changed, 39 insertions(+), 25 deletions(-)

diff --git a/.gitignore b/.gitignore
index 82894bc..db21f83 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,4 +5,8 @@ target/
 # Eclipse
 .settings/
 .classpath
-.project
\ No newline at end of file
+.project
+
+#Other
+.backup/
+release.properties
\ No newline at end of file
diff --git a/README.md b/README.md
index 2414193..ce49a4b 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,34 @@
+
 # romaji-henkan
-A Java library for converting Japanese text to Latin alphabet (romaji)
+Romaji-henkan is a simple open-source Java library for converting Japanese text to Latin alphabet (romaji)
 
-Powered by [kuromoji](https://github.com/atilika/kuromoji), some part of the code were taken from [moji4j](https://github.com/andree-surya/moji4j). 
-
-## Usage:
-
-```java
-import com.bernd32.romajihenkan;
-
-RomajiHenkan henkan = new RomajiHenkan();
-henkan.convert("自己紹介の最後に添える挨拶として使う表現"); // jikō shōkai nō saigō ni sōeru aisatsu tōshite tsukau hyōgen
+## Example:
+Add the dependency to your `pom.xml`:
+```xml
+<dependency>
+  <groupId>io.github.bernd32</groupId>
+  <artifactId>romaji-henkan</artifactId>
+  <version>0.0.1</version>
+</dependency>
 ```
+The following code converts string in Japanese to romaji:
+```java
+import com.bernd32.romajihenkan.RomajiHenkan;
+public class RomajiHenkanExample {
+    public static void main(String[] args) {
+		RomajiHenkan henkan = new RomajiHenkan();
+		System.out.println(henkan.convert("自己紹介の最後に添える挨拶として使う表現")); 
+	}
+}
+```
+ Output: 
+```
+jikō shōkai nō saigō ni sōeru aisatsu tōshite tsukau hyōgen
+```
+## Additional information
+Powered by [kuromoji](https://github.com/atilika/kuromoji), some part of the code were taken from [moji4j](https://github.com/andree-surya/moji4j).  
+This library is using IPADIC dictionary.
+
 ## License
 
    Romaji-henkan is licensed under the MIT License. See `LICENSE.md` for details.
diff --git a/pom.xml b/pom.xml
index d310d88..656450c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -20,10 +20,11 @@
         </license>
     </licenses>
     <scm>
-        <connection>scm:git:git@github.com:bernd32/romaji-henkan.git</connection>
+        <connection>scm:git:git://github.com/bernd32/romaji-henkan.git</connection>
+        <developerConnection>scm:git:git@github.com:bernd32/romaji-henkan.git</developerConnection>
         <url>https://github.com/bernd32/romaji-henkan/tree/master</url>
-      <tag>romaji-henkan-0.0.1</tag>
-  </scm>
+        <tag>HEAD</tag>
+    </scm>
     <distributionManagement>
         <snapshotRepository>
             <id>ossrh</id>
@@ -65,16 +66,6 @@
                     </execution>
                 </executions>
             </plugin>
-            <plugin>
-              <groupId>org.apache.maven.plugins</groupId>
-              <artifactId>maven-release-plugin</artifactId>
-              <version>3.0.0-M1</version>
-              <configuration>
-                <checkModificationExcludes>
-                    <checkModificationExclude>pom.xml</checkModificationExclude>
-                </checkModificationExcludes>
-              </configuration>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
@@ -121,6 +112,7 @@
             </plugin>
         </plugins>
     </build>
+    
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
@@ -133,7 +125,7 @@
 	        <scope>test</scope>
 	    </dependency>
         
-        <dependency>
+    <dependency>
             <groupId>com.atilika.kuromoji</groupId>
             <artifactId>kuromoji-ipadic</artifactId>
             <version>0.9.0</version>