diff --git a/README.md b/README.md index c3d3a0b..1167f2f 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,25 @@ The package is named `tinyvm` for 'tiny version manager'. Since this is an internship application project, I have assumed that a minimal usage of external libraries is preferred, so that a greater technical understanding can be demonstrated. +## Usage + +### Gradle +```kotlin +repositories { + // other repositories + maven { url "https://git.koval.net/api/packages/cyclane/maven" } +} + +dependencies { + implementation("net.koval.teamcity-gitea-test-task:tinyvm:0.1.0") +} +``` + +### Documentation +Use autocompletion and hover menus in your IDE, or download the +[generated HTML documentation](https://git.koval.net/cyclane/teamcity-gitea-test-task/releases/download/v0.1.0/tinyvm-0.1.0-javadoc.zip) +from the [latest release](https://git.koval.net/cyclane/teamcity-gitea-test-task/releases). + ## Instructions Create a library that implements simple Git functionality. You need to implement at least three entities: