Added readme

This commit is contained in:
Andrew Lalis 2017-06-30 14:17:19 +02:00 committed by Andrew Lalis
parent 144fb90371
commit 4394b6e8f3
1 changed files with 19 additions and 0 deletions

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# Tengwar Translator Library
A Java library containing an algorithm and some utility functions to transform normal human latin text into *Tengwar* text, and back, too! To include this library in your project, add the following to your Maven **.pom** file. *Replace `@VERSION@` with the latest version.*
```xml
<project>
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>com.github.andrewlalis</groupId>
<artifactId>TengwarTranslator</artifactId>
<version>@VERSION@</version>
</dependency>
</project>
```