Skip to content

Commit

Permalink
Added tag and installation instructions to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Lundez authored Nov 28, 2019
1 parent 569c174 commit f3774ed
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
[![](https://jitpack.io/v/com.londogard/summarize-kt.svg)](https://jitpack.io/#com.londogard/summarize-kt)

# summarize-kt
Summarisation library. Easy-to-use API with ready models.

## Installation
### Jitpack (easiest)
Add the following to your `build.gradle`. `$version` should be equal to the version supplied by tag above.
```
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
implementation 'com.github.jitpack:com.londogard:summarize-kt:$version'
}
```
### GitHub Packages
Add the following to your `build.gradle`. `$version` should be equal to the version supplied by tag above.
The part with logging into github repository is how I understand that you need to login. If you know a better way please ping me in an issue.
```
repositories {
maven {
url = uri("https://maven.pkg.github.com/londogard/summarize-kt")
credentials {
username = project.findProperty("gpr.user") ?: System.getenv("GH_USERNAME")
password = project.findProperty("gpr.key") ?: System.getenv("GH_TOKEN")
}
}
}
dependencies {
implementation "com.londogard:summarize-kt:$version"
}
```

0 comments on commit f3774ed

Please sign in to comment.