Skip to content

Commit c8e8eac

Browse files
authored
Merge pull request #98 from EbenezerGH/update-documentation-v0.8.0-release
Update documentation v0.8.0 release
2 parents 934bd36 + 49daca5 commit c8e8eac

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

+20-5
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,44 @@
11
[![Generic badge](https://img.shields.io/badge/EtherscanApi-UP-brightgreen.svg)](https://api.etherscan.io/api?module=stats&action=ethprice&apikey=YourApiKeyToken)
22
[![Generic badge](https://img.shields.io/badge/CircleCI-UP-brightgreen.svg)](https://circleci.com/gh/EbenezerGH/hello_etherscan/tree/master)
3-
[![Generic badge](https://img.shields.io/badge/Version-v0.7.0-beta.1,-yellow.svg)](https://circleci.com/gh/EbenezerGH/hello_etherscan/tree/master)
3+
[![Generic badge](https://img.shields.io/badge/Version-v0.8.0-lightgrey.svg)](https://github.com/EbenezerGH/etherscan-android-api/releases)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/EbenezerGH/hello_etherscan/blob/update-documentation/LICENSE)
55

66
# etherscan-android-api
77

88
etherscan android api is an android wrapper for the [etherscan api](https://etherscan.io/apis). This is just a module to handle networking calls.
99

10-
[features](https://github.com/EbenezerGH/hello_etherscan/issues) Though this version is completely safe to use, There are a couple of edge cases to be handled before the first version.
10+
There are only a few [features](https://github.com/EbenezerGH/hello_etherscan/issues) left to complete, however this version is completely safe to use.
1111

1212
## Getting Started
1313

14-
import a reactive android library to handle the reactive stream being passed into your module.
14+
Add JitPack to your root build.gradle at the end of repositories
15+
```
16+
allprojects {
17+
repositories {
18+
...
19+
maven { url 'https://jitpack.io' }
20+
}
21+
}
22+
```
23+
Add the dependency
24+
```
25+
dependencies {
26+
implementation 'com.github.EbenezerGH:hello_etherscan:v0.8.0'
27+
}
28+
```
29+
import a reactive android library to handle the reactive stream being passed into your module. For instance I used the following:
1530

1631

1732
implementation 'io.reactivex.rxjava2:rxandroid:x.y.z'
1833
implementation 'io.reactivex.rxjava2:rxkotlin:x.y.z'
1934

2035

21-
Optional: Call `ApiKey.takeOff.setApiKey("[your api key here]")` in module's application class when recording api usage in the etherscan.io console. [see [example implementation](https://github.com/EbenezerGH/hello_etherscan/blob/master/app/src/main/java/jfyg/etherscan/helloetherescan/HelloEtherscanApplication.kt)]
36+
Optional: Call `ApiKey.takeOff.setApiKey("[your api key here]")` in your module's application class when recording api usage in the etherscan.io console. [see [example implementation](https://github.com/EbenezerGH/etherscan-android-api/blob/master/etherscan-sample/src/main/java/jfyg/etherscan/helloetherescan/EtherscanSampleApplication.kt)]
2237
```
2338
ApiKey.takeOff.setApiKey("1I7CRNU2QIU253UBPFVB5UV2C2PBDURAIYZ")
2439
```
2540

26-
Create an Instance of one of the reactive Singles and access values by specifying thread and subscribing. [see [example implementation](https://github.com/EbenezerGH/hello_etherscan/blob/master/app/src/main/java/jfyg/etherscan/helloetherescan/MainActivity.kt)]
41+
Create an Instance of one of the reactive Singles and access values by specifying thread and subscribing. [see [example implementation](https://github.com/EbenezerGH/etherscan-android-api/blob/master/etherscan-sample/src/main/java/jfyg/etherscan/helloetherescan/SampleActivity.kt)]
2742

2843
Currently Available: ``[accounts, contracts, transactions, blocks, stat]``
2944

0 commit comments

Comments
 (0)