diff --git a/README.md b/README.md index 77226ec..08b63e0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# TypeWriter-TextView +# TypeWriter Android Library to Get Smooth and Polished Typewriter Effect for TextView + +> +> More Documentation about implementation will be added soon +> + +## How to use + +To get a Git project into your build: + +**Step 1.** Add the JitPack repository to your build file + +Add it in your root build.gradle at the end of repositories: + +```css + allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } + } +``` + +**Step 2.** Add the dependency + +```css + dependencies { + implementation 'com.github.NitishGadangi:TypeWriter-TextView:v1.1' + } +```