diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..8d15c61 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Request a feature for Pocket Android +title: "[FEATURE REQUEST]" +labels: enhancement +assignees: andrewnguyen22 + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**(Optional) Include a BDD test that would satisfy the expected behaviour of the new feature** + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8e1fae5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## How to contribute + +PocketAndroid is an open source project, and as such we welcome any contribution from anyone on the internet. Please read our [visit our developer portal](https://pocket-network.readme.io) to learn how get started. + +Please fork, code and submit a Pull Request for the PocketAndroid Team to review and merge. We ask that you please follow the guidelines below in order to submit your contributions for review: + +### High impact or architectural changes + +Reach out to us on [Telegram](https://t.me/POKTnetwork) and start a discussion with the Pocket Core Team regarding your change before you start working. Communication is key for open source projects and asynchronous contributions. + +For an active research forum, checkout and post on [our forum](https://research.pokt.network). + +### Coding style +- Code must adhere to the our Kotlin formatting guidelines. +- Pull requests need to be based on and opened against the `staging` branch. diff --git a/README.md b/README.md index b80c28b..2b492fe 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,88 @@ -
- - drawing - -
-

PocketAndroid

-
Official Android client to use with the Pocket Network
-
- - - -
- -

Overview

-
- - - - - - - - - - - - -
- - - - - - - - - -
- -PocketAndroid wraps all of the tools a developer will need to begin interacting with a network. PocketAndroid contains 3 packages: - -- `network.pocket:eth`: A library that allows your DApp to communicate to the Ethereum network. -- `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) - -

Requirements

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

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 { - google() - jcenter() - maven { - url 'https://dl.bintray.com/pokt-network/pocket-android' - } - } -} -``` - -Now, you will need to add either of the 3 packages within PocketAndroid to your module's `build.gradle` file, like this: - -``` -// Eth -implementation 'network.pocket:eth:0.0.1' - -// Aion -implementation 'network.pocket:aion:0.0.1' - -// Core -implementation 'network.pocket:core:0.0.1' -``` - -

Usage

- -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

- -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 +
+ + Pocket Network logo + +
+ +

PocketAndroid

+
Official Android client to use with the Pocket Network
+
+ + + +
+ +

Overview

+
+ + + + + + + + + + + + +
+ + + + + + + + + +
+ +PocketAndroid wraps all of the tools a developer will need to begin interacting with a network. PocketAndroid contains 3 packages: + +- `network.pocket:eth`: A library that allows your DApp to communicate to the Ethereum network. +- `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) + +

Requirements

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

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 { + google() + jcenter() + maven { + url 'https://dl.bintray.com/pokt-network/pocket-android' + } + } +} +``` + +Now, you will need to add either of the 3 packages within PocketAndroid to your module's `build.gradle` file, like this: + +``` +// Eth +implementation 'network.pocket:eth:0.0.1' + +// Aion +implementation 'network.pocket:aion:0.0.1' + +// Core +implementation 'network.pocket:core:0.0.1' +``` + +

Usage

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

+ +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)