-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:XYOracleNetwork/sdk-objectmodel-k…
…otlin
- Loading branch information
Showing
1 changed file
with
1 addition
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,86 +2,7 @@ | |
|
||
![logo] | ||
|
||
# sdk-core-kotlin | ||
|
||
[](https://jitpack.io/#XYOracleNetwork/sdk-core-kotlin) [](https://gitter.im/XYOracleNetwork/Dev) [](https://codeclimate.com/github/XYOracleNetwork/sdk-core-kotlin/maintainability) | ||
|
||
| Branches | Status | | ||
| ------------- |:-------------:| | ||
| Master | [](https://circleci.com/gh/XYOracleNetwork/sdk-core-kotlin) | | ||
| Develop | [](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/#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 | ||
|