From 641e42ee2c8b9b514123733da5861fdf48db75c4 Mon Sep 17 00:00:00 2001 From: Gleb Koval Date: Sat, 2 Dec 2023 02:47:15 +0000 Subject: [PATCH 1/2] gradle usage --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index c3d3a0b..c686c89 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,20 @@ 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") +} +``` + ## Instructions Create a library that implements simple Git functionality. You need to implement at least three entities: -- 2.40.1 From 21b4bdeae1578dd76eb662c6f792fc5254b55731 Mon Sep 17 00:00:00 2001 From: Gleb Koval Date: Sat, 2 Dec 2023 03:38:41 +0000 Subject: [PATCH 2/2] Documentation README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c686c89..1167f2f 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,11 @@ dependencies { } ``` +### 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: -- 2.40.1