diff --git a/README.md b/README.md index 9326ec6..6e0d026 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,48 @@ which is capable of transcribing most orthographical information present in a la Some languages are partially or completely incompatible with this approach; [details are below](#depth). +## How To Install + +First, add the jitpack repository if you haven't already: + +`gradle` +``` gradle +allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } +} +``` + +`maven` +``` xml + + + jitpack.io + https://jitpack.io + + +``` + +Then add this library to your project: + +`gradle` +``` gradle +dependencies { + implementation 'com.github.medavox:IPA-Transcribers:v0.1' +} +``` + +`maven` +``` xml + + com.github.medavox + IPA-Transcribers + v0.1 + +``` + ## Language Support The languages I aim to support, and their eligibility for rule-based transcribers: