diff --git a/README.md b/README.md index 6a8c78bd93606ae4a6d5ef69fa140692d063dc86..97972f17c5b64f6c3fdd0e40288e960689a0e7fa 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [](https://git.ucsc.edu/wnwalker/temerity/-/packages) [](https://git.ucsc.edu/wnwalker/temerity/-/pipelines) [](https://git.ucsc.edu/wnwalker/temerity/-/issues) -[](http://kotlinlang.org) +[](http://kotlinlang.org) [](https://gradle.org) [](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html) @@ -15,7 +15,7 @@ The library is available from the public Maven repository for this Gitlab projec ### Dependency setup instructions -Add the Maven repository, either in your build.gradle.kts file or in a `dependencyResolutionManagement{}` block in your settings.gradle.kts file. +Add the Maven repository if it is not already present, either in your build.gradle.kts file or in a `dependencyResolutionManagement{}` block in your settings.gradle.kts file. ```kotlin repositories { @@ -58,7 +58,7 @@ Build a Temerity client, then start making requests: stopTemerity() ``` -### Result: +## Result: ```kotlin User(loginId=...., emailAddress=...., userType=Student, userId=12345678, timezone=America/Los_Angeles, customId=, lastName=..., diff --git a/temerity/README.md b/temerity/README.md deleted file mode 100644 index 6f02628a1aa30f0e58ecfefafce6b59de02a57b4..0000000000000000000000000000000000000000 --- a/temerity/README.md +++ /dev/null @@ -1,73 +0,0 @@ -# Temerity - -***Kotlin Multiplatform Library for interacting with the YuJa Enterprise Video Platform*** - -[](https://git.ucsc.edu/wnwalker/temerity/-/packages) -[](https://git.ucsc.edu/wnwalker/temerity/-/pipelines) -[](https://git.ucsc.edu/wnwalker/temerity/-/issues) -[](http://kotlinlang.org) -[](https://gradle.org) -[](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html) - -## How to add and use this library - -The library is available from the public Maven repository for this Gitlab project. - -### Dependency setup instructions - -Add the Maven repository if it is not already present, either in your build.gradle.kts file or in a `dependencyResolutionManagement{}` block in your settings.gradle.kts file. - -```kotlin -repositories { - maven("https://git.ucsc.edu/api/v4/projects/12162/packages/maven") -} -``` - -To use the library in a regular JVM project, add a dependency. - -```kotlin -dependencies { - implementation("edu.ucsc.its:temerity-jvm:0.1.0") -} -``` - -In Kotlin Multiplatform projects, add the dependency to the commonMain source-set. - -```kotlin -commonMain { - dependencies { - implementation("edu.ucsc.its:temerity:0.1.0") - } -} -``` - -### Usage - -Build a Temerity client, then start making requests: - -```kotlin - val client = Temerity { - serviceUrl("https://your_organization.yuja.com/services/") - serviceToken("your_API_token") } - runBlocking { client.getUsers().forEach { println(it) } } - - val returnedDevices = runBlocking { client.getDevices() } - println("Returned devices:") - returnedDevices.forEach { println(it) } - - stopTemerity() -``` - -## Result: - -```kotlin -User(loginId=...., emailAddress=...., userType=Student, userId=12345678, timezone=America/Los_Angeles, customId=, lastName=..., -User(...) -User(...) - -// Returned devices: -Device(stationName=DELL-DATAPATH-9020, accessLevel=Administrators, deviceId=... -Device(stationName=DELL-DATAPATH-7040, accessLevel=Administrators, deviceId=... -Device(... -Device(... -``` \ No newline at end of file