wulkanowy/sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update readme

Browse source
This commit is contained in:
Mikołaj Pich 2019-06-20 22:13:40 +02:00
parent a4f830ea3e
commit 46add5bb74
No known key found for this signature in database
GPG key ID: F62B26E36D4C4BAA
1 changed files with 25 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,6 +1,29 @@
# sdk
# VULCAN UONET+ SDK
[![Codecov branch](https://img.shields.io/codecov/c/github/wulkanowy/sdk/master.svg?style=flat-square)](https://codecov.io/gh/wulkanowy/sdk)
[![CircleCI branch](https://img.shields.io/circleci/project/github/wulkanowy/sdk/master.svg?style=flat-square)](https://circleci.com/gh/wulkanowy/sdk)
[![JitPack](https://img.shields.io/jitpack/v/wulkanowy/sdk.svg?style=flat-square)](https://jitpack.io/#wulkanowy/sdk)
[![License](https://img.shields.io/github/license/wulkanowy/sdk.svg?style=flat-square)](https://github.com/wulkanowy/sdk)
[![Discord](https://img.shields.io/discord/390889354199040011.svg?style=flat-square)](https://discord.gg/vccAQBr)
Implementation of https://gitlab.com/erupcja/uonet-api-docs
> Unified way of retrieving data from the UONET+ register through mobile api and scraping api
## Features
Check it out [full public api](https://github.com/wulkanowy/sdk/blob/master/src/main/kotlin/io/github/wulkanowy/sdk/Sdk.kt)
and [test examples](https://github.com/wulkanowy/sdk/blob/master/src/test/kotlin/io/github/wulkanowy/sdk/SdkRemoteTest.kt).
## Download
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'io.github.wulkanowy:sdk:master-SNAPSHOT'
}
```