Skip to content

Commit

Permalink
Merge branch 'master' of github.com:XYOracleNetwork/sdk-objectmodel-k…
Browse files Browse the repository at this point in the history
…otlin
  • Loading branch information
carterharrison committed Nov 18, 2018
2 parents 614b158 + 7f6734c commit fa77ec5
Showing 1 changed file with 1 addition and 80 deletions.
81 changes: 1 addition & 80 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,86 +2,7 @@

![logo]

# sdk-core-kotlin

[![](https://jitpack.io/v/XYOracleNetwork/sdk-core-kotlin.svg)](https://jitpack.io/#XYOracleNetwork/sdk-core-kotlin) [![](https://img.shields.io/gitter/room/XYOracleNetwork/Stardust.svg)](https://gitter.im/XYOracleNetwork/Dev) [![Maintainability](https://api.codeclimate.com/v1/badges/af641257b27ecea22a9f/maintainability)](https://codeclimate.com/github/XYOracleNetwork/sdk-core-kotlin/maintainability)

| Branches | Status |
| ------------- |:-------------:|
| Master | [![](https://circleci.com/gh/XYOracleNetwork/sdk-core-kotlin.svg?style=shield)](https://circleci.com/gh/XYOracleNetwork/sdk-core-kotlin) |
| Develop | [![](https://circleci.com/gh/XYOracleNetwork/sdk-core-kotlin/tree/develop.svg?style=shield)](https://circleci.com/gh/XYOracleNetwork/sdk-core-kotlin/tree/develop) |

A library to preform all basic XYO Network functions.
This includes creating an origin chain, maintaining an origin chain, negotiations for talking to other nodes, and other basic functionality.
The library has heavily abstracted modules so that all operations will work with any crypto, storage, networking, ect.

## Installing
You can add sdk-core-kotlin to your existing app by cloning the project and manually adding it to your build.gradle or by using JitPack.

### Build From Source

#### Clone from github
```
git clone [email protected]:XYOracleNetwork/sdk-core-kotlin.git
```

#### Add project to settings.gradle
```
include ':sdk-core-kotlin'
project(':mod-tcp-kotlin').projectDir = new File('../mod-tcp-kotlin')
```

#### Include in project
```
implementation project (':sdk-core-kotlin')
```

```gradle
dependencies {
implementation 'com.github.XYOracleNetwork:sdk-core-kotlin:v0.1.0-beta'
}
```

### Using JitPack with Gitpack
[![](https://jitpack.io/v/XYOracleNetwork/sdk-core-kotlin.svg)](https://jitpack.io/#XYOracleNetwork/sdk-core-kotlin)

#### With Gradle
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```

```gradle
dependencies {
implementation 'com.github.XYOracleNetwork:sdk-core-kotlin:Tag'
}
```

#### With Maven
```maven
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
```

```maven
<dependency>
<groupId>com.github.XYOracleNetwork</groupId>
<artifactId>sdk-core-kotlin</artifactId>
<version>Tag</version>
</dependency>
```

#### Prerequisites
* JDK 1.8
* Kotlin
# sdk-objectmodel-kotlin

## License
This project is licensed under the MIT License - see the LICENSE.md file for details
Expand Down

0 comments on commit fa77ec5

Please sign in to comment.