Skip to content

Commit 42dcee8

Browse files
Feature/doc update installation (#61)
Updated README.MD file to include installation instructions. Co-authored-by: Eren <[email protected]>
1 parent 21dd569 commit 42dcee8

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,56 @@
11
# helium-java-sdk
22

3-
> **Warning**
4-
> This project is at a very early stage and not ready to be used in the wild.
5-
63
A Java SDK for [Helium Blockchain APIs](https://docs.helium.com/api/blockchain/introduction/).
74

85
Easily integrate to Helium Blockhain API in your java applications for `Android`, `Backend`, `Console`...
96

10-
The SDK is based on `Java 1.8` uses the following dependencies:
7+
The SDK is based on `Java 1.8` and uses the following dependencies:
118

129
* OkHttp3
1310
* Gson
1411

1512
# Usage
1613

1714
## Installation
15+
You can add `helium-java-sdk` to your project by using popular build systems like Gradle or Maven.
16+
17+
### Gradle
18+
Add JitPack repository in your root build.gradle file.
19+
```groovy
20+
allprojects {
21+
repositories {
22+
...
23+
maven { url 'https://jitpack.io' }
24+
}
25+
}
26+
```
1827

19-
> **TODO**: Update here after GithubRepository integration.
28+
Add the dependency in your module level build.gradle file.
29+
```groovy
30+
dependencies {
31+
implementation 'com.github.AppcentMobile:helium-java-sdk:1.0.0-SNAPSHOT'
32+
}
33+
```
2034

21-
The SDK is not available on any maven repository yet. Currently only way to include it in your projects is by copying the source code.
35+
### Maven
36+
Add JitPack repository to your build file.
37+
```xml
38+
<repositories>
39+
<repository>
40+
<id>jitpack.io</id>
41+
<url>https://jitpack.io</url>
42+
</repository>
43+
</repositories>
44+
```
45+
Add the dependency.
46+
```xml
47+
<dependency>
48+
<groupId>com.github.AppcentMobile</groupId>
49+
<artifactId>helium-java-sdk</artifactId>
50+
<version>1.0.0-SNAPSHOT</version>
51+
</dependency>
52+
```
2253

23-
When we feel comfortable on releasing first alpha, it will be available on a maven repository.
2454

2555
## Initialization
2656

0 commit comments

Comments
 (0)