cyclane
/
teamcity-gitea-test-task
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 3 Activity

Improve README - usage (#5)
Publish Workflow / Publish library (push) Successful in 7m57s Details
Test Workflow / Lint and test library (push) Successful in 16m38s Details 

Include instructions for usage of library in README, as well as how to view documentation.

Reviewed-on: #5
This commit is contained in:
Gleb Koval 2023-12-02 03:50:13 +00:00
parent 0e1afa6dc8
commit 804778b0fc
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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: