pom.xml and README.md update

.gitignore

@@ -6,3 +6,7 @@ target/
 .settings/
 .classpath
 .project
+
+#Other
+.backup/
+release.properties

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). 
+## Example:
-
+Add the dependency to your `pom.xml`:
-## Usage:
+```xml
-
+<dependency>
-```java
+  <groupId>io.github.bernd32</groupId>
-import com.bernd32.romajihenkan;
+  <artifactId>romaji-henkan</artifactId>
-
+  <version>0.0.1</version>
-RomajiHenkan henkan = new RomajiHenkan();
+</dependency>
-henkan.convert("自己紹介の最後に添える挨拶として使う表現"); // jikō shōkai nō saigō ni sōeru aisatsu tōshite tsukau hyōgen
 ```
+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.

pom.xml

@@ -20,9 +20,10 @@
         </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>
+        <tag>HEAD</tag>
     </scm>
     <distributionManagement>
         <snapshotRepository>
@@ -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>