Skip to content

Fixes #73; adds issue template dir #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nymd wants to merge 3 commits into
base: staging
Choose a base branch
from
Open

Fixes #73; adds issue template dir #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fcce3b
Fixes #73; adds issue template dir
nymd Jan 16, 2020
1e011ca
Fixes #73; contributions and templates
nymd Feb 10, 2020
5662c61
Fixes #73; fixes repo image
nymd Feb 10, 2020
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
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
175 changes: 88 additions & 87 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,87 +1,88 @@
<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"/>
</a>
</div>
<h1 align="left">PocketAndroid</h1>
<h6 align="left">Official Android client to use with the Pocket Network</h6>
<div align="lef">
<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>
<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>
<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>
</div>

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)

<h1 align="left">Requirements</h1>

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

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

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

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

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>

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)
<div align="center">
<a href="https://www.pokt.network">
<img src="https://user-images.githubusercontent.com/16605170/74199287-94f17680-4c18-11ea-9de2-b094fab91431.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">
<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>
<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>
<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>
</div>

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)

<h1 align="left">Requirements</h1>

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

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

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

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

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>

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)