Skip to content

Commit

Permalink
chore: update the docs and build file
Browse files Browse the repository at this point in the history
  • Loading branch information
pavelgordon committed Jun 19, 2021
1 parent a3eb443 commit 144ca52
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

39 changes: 33 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,44 @@ This is an unofficial JVM library for Oura Cloud API written in Kotlin, which ca

Install
====================
Gradle(NOT PUBLISHED YET):



Gradle:

1. Add the JitPack repository to your build file.
Add it in your root build.gradle at the end of repositories:
```
implementation "dev.pgordon:oura-ring-api:0.0.1"
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
2. Add the dependency
```
dependencies {
implementation 'com.github.pavelgordon:oura-ring-api:v0.0.1'
}
```

Maven(NOT PUBLISHED YET)::
Maven:
1. Add the JitPack repository to your build file
```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
```
2. Add the dependency
```xml
<dependency>
<groupId>dev.pgordon</groupId>
<artifactId>oura-ring-api</artifactId>
<version>0.0.1</version>
<groupId>com.github.pavelgordon</groupId>
<artifactId>oura-ring-api</artifactId>
<version>v0.0.1</version>
</dependency>
```
Authorisation
Expand Down
5 changes: 3 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
kotlin("jvm") version "1.5.0"
id("maven")
}

group = "dev.pgordon"
version = "0.0.1-SNAPSHOT"
group = "com.github.pavelgordon"
version = "0.0.1"

repositories {
mavenCentral()
Expand Down

0 comments on commit 144ca52

Please sign in to comment.