Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
73 changes: 40 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,30 @@



<div align="center">
<a href="https://www.pokt.network">
<img src="https://pokt.network/wp-content/uploads/2018/12/Logo-488x228-px.png" alt="drawing" width="340"/>
<img src="https://pokt.network/wp-content/uploads/2018/12/Logo-488x228-px.png" alt="Pocket Network logo" width="340"/>
</a>
</div>
<h1 align="left">PocketAndroid</h1>
<h6 align="left">Official Android client to use with the Pocket Network</h6>
<div align="lef">

# PocketAndroid
Official Android client to use with the Pocket Network
<div align="left">
<a href="https://developer.android.com/docs">
<img src="https://img.shields.io/badge/android-reference-green.svg"/>
</a>
</div>

<h1 align="left">Overview</h1>
## Overview
<div align="left">
<a href="https://github.com/pokt-network/pocket-android/releases">
<img src="https://img.shields.io/github/release-pre/pokt-network/pocket-android.svg"/>
</a>
<a href="https://circleci.com/gh/pokt-network/pocket-android/tree/master">
<img src="https://circleci.com/gh/pokt-network/pocket-android/tree/master.svg?style=svg"/>
</a>
<a href="https://github.com/pokt-network/pocket-android/pulse">
<img src="https://img.shields.io/github/contributors/pokt-network/pocket-android.svg"/>
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg"/>
</a>
<a href="https://github.com/pokt-network/pocket-android/releases"><img src="https://img.shields.io/github/release-pre/pokt-network/pocket-android.svg"/></a>
<a href="https://circleci.com/gh/pokt-network/pocket-android/tree/master"><img src="https://circleci.com/gh/pokt-network/pocket-android/tree/master.svg?style=svg"/></a>
<a href="https://github.com/pokt-network/pocket-android/pulse"><img src="https://img.shields.io/github/contributors/pokt-network/pocket-android.svg"/></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"/></a>
<br >
<a href="https://github.com/pokt-network/pocket-android/pulse">
<img src="https://img.shields.io/github/last-commit/pokt-network/pocket-android.svg"/>
</a>
<a href="https://github.com/pokt-network/pocket-android/pulls">
<img src="https://img.shields.io/github/issues-pr/pokt-network/pocket-android.svg"/>
</a>
<a href="https://github.com/pokt-network/pocket-android/issues">
<img src="https://img.shields.io/github/issues-closed/pokt-network/pocket-android.svg"/>
</a>
<a href="https://github.com/pokt-network/pocket-android/pulse"><img src="https://img.shields.io/github/last-commit/pokt-network/pocket-android.svg"/></a>
<a href="https://github.com/pokt-network/pocket-android/pulls"><img src="https://img.shields.io/github/issues-pr/pokt-network/pocket-android.svg"/></a>
<a href="https://github.com/pokt-network/pocket-android/issues"><img src="https://img.shields.io/github/issues-closed/pokt-network/pocket-android.svg"/></a>
</div>

PocketAndroid wraps all of the tools a developer will need to begin interacting with a network. PocketAndroid contains 3 packages:
Expand All @@ -43,16 +33,19 @@ PocketAndroid wraps all of the tools a developer will need to begin interacting
- `network.pocket:aion`: A library that allows your DApp to communicate to the AION network.
- `network.pocket:core`: An implementation of the Pocket protocol that you can use to create your own plugin to interact with a blockchain of your choosing.

Before you can start using the library, you have to get a Developer ID by registering for MVP. [To learn how to register please click here.](https://pocket-network.readme.io/docs/how-to-participate#section-for-developers)
Before you can start using the library, you have to get a Developer ID by [registering for Testnet](https://pocket-network.readme.io/docs/how-to-participate#section-for-developers).

<h1 align="left">Requirements</h1>
## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Requirements

You should have at least have a basic knowledge of blockchain technology and know your way around Java/Kotlin.

<h1 align="left">Installation</h1>
### Installation

First you need to add the following Maven URL to your project, so the your root `build.gradle` file add the following:

```
allprojects {
repositories {
Expand All @@ -78,10 +71,24 @@ implementation 'network.pocket:aion:0.0.1'
implementation 'network.pocket:core:0.0.1'
```

<h1 align="left">Usage</h1>
## Documentation

If you would like to know how to integrate PocketAndroid into your DApp, [visit our developer portal](https://pocket-network.readme.io) that has a lot of useful tutorials and material about the Pocket Network.

<h1 align="left">Contact Us</h1>
## Contributing

Please read [CONTRIBUTING.md](https://github.com/pokt-network/pocket-android/blob/master/CONTRIBUTING.md) for details on contributions and the process of submitting pull requests.

## Support & Contact

<div>
<a href="https://twitter.com/poktnetwork" ><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social"></a>
<a href="https://t.me/POKTnetwork"><img src="https://img.shields.io/badge/Telegram-blue.svg"></a>
<a href="https://www.facebook.com/POKTnetwork" ><img src="https://img.shields.io/badge/Facebook-red.svg"></a>
<a href="https://research.pokt.network"><img src="https://img.shields.io/discourse/https/research.pokt.network/posts.svg"></a>
</div>


## License

We have created a Discord server where you can meet with the Pocket team, as well as fellow App Developers, and Service Nodes. [Click here to join!](https://discord.gg/sarhfXP)
This project is licensed under the MIT License; see the [LICENSE.md](LICENSE.md) file for details.