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
+
+ io.github.bernd32
+ romaji-henkan
+ 0.0.1
+
```
+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 @@
- scm:git:git@github.com:bernd32/romaji-henkan.git
+ scm:git:git://github.com/bernd32/romaji-henkan.git
+ scm:git:git@github.com:bernd32/romaji-henkan.git
https://github.com/bernd32/romaji-henkan/tree/master
- romaji-henkan-0.0.1
-
+ HEAD
+
ossrh
@@ -65,16 +66,6 @@
-
- org.apache.maven.plugins
- maven-release-plugin
- 3.0.0-M1
-
-
- pom.xml
-
-
-
org.apache.maven.plugins
maven-javadoc-plugin
@@ -121,6 +112,7 @@
+
UTF-8
@@ -133,7 +125,7 @@
test
-
+
com.atilika.kuromoji
kuromoji-ipadic
0.9.0