diff --git a/README.md b/README.md new file mode 100644 index 0000000..d314379 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# romaji-henkan +A Java library for converting Japanese text to Latin alphabet (romaji) + +Powered by [kuromoji](https://github.com/atilika/kuromoji), some part of code were taken from [moji4j](https://github.com/andree-surya/moji4j). + +Usage: + + RomajiHenkan henkan = new RomajiHenkan(); + henkan.convert("自己紹介の最後に添える挨拶として使う表現"); // jikō shōkai nō saigō ni sōeru aisatsu tōshite tsukau hyōgen + +## License + + Romaji-henkan is licensed under the MIT License. See `LICENSE.md` for details.