diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index b80c28b..2734788 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,30 @@ + + +
- drawing + Pocket Network logo
-

PocketAndroid

-
Official Android client to use with the Pocket Network
-
+ +# PocketAndroid +Official Android client to use with the Pocket Network +
-

Overview

+## Overview
- - - - - - - - - - - - + + + +
- - - - - - - - - + + +
PocketAndroid wraps all of the tools a developer will need to begin interacting with a network. PocketAndroid contains 3 packages: @@ -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). -

Requirements

+## 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. -

Installation

+### 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 { @@ -78,10 +71,24 @@ implementation 'network.pocket:aion:0.0.1' implementation 'network.pocket:core:0.0.1' ``` -

Usage

+## 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. -

Contact Us

+## 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 + +
+ + + + +
+ + +## 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) \ No newline at end of file +This project is licensed under the MIT License; see the [LICENSE.md](LICENSE.md) file for details.