Skip to content
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.

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

Add documentation & example #7

Open
pedrouid opened this issue May 9, 2019 · 3 comments

Comments

Projects
None yet
2 participants
@pedrouid
Copy link
Member

commented May 9, 2019

Context

This repository needs more context on the README file to be used by Android developers. As a reference let's use the swift-walletconnect-lib repository as an example of what is required to complete this bounty.

Goal

Include more information on the README file and additionally include an example app that can be used for testing.

Requirements

  • Example app (see swift-walletconnect-lib for example)
  • Demo video
  • List requirements
  • List Features (including TODO)
  • Describe Installation process
  • Describe Usage (including API reference)

Notes

If there are any other information that is commonly included in Kotlin libraries for Android developers, please also include these in the README.

@gitcoinbot

This comment has been minimized.

Copy link

commented May 9, 2019

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


This issue now has a funding of 50.0 DAI (50.0 USD @ $1.0/DAI) attached to it as part of the WalletConnect fund.

@gitcoinbot

This comment has been minimized.

Copy link

commented May 10, 2019

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 4 weeks, 1 day from now.
Please review their action plans below:

1) aerophile has started work.

Hey, I've worked on documentation issues in the past and I'm interested in working on this as well. I have had a look at swift wallet connect lib's Readme. I think a similar readme can be created. Will reachout if I have questions during the process. If accepted, I'll aim to complete by the weekend.

Learn more on the Gitcoin Issue Details page.

@gitcoinbot

This comment has been minimized.

Copy link

commented May 15, 2019

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 3 weeks, 2 days from now.
Please review their action plans below:

1) aerophile has started work.

Hey, I've worked on documentation issues in the past and I'm interested in working on this as well. I have had a look at swift wallet connect lib's Readme. I think a similar readme can be created. Will reachout if I have questions during the process. If accepted, I'll aim to complete by the weekend.

Learn more on the Gitcoin Issue Details page.

2) ssd4130 has started work.

I am Docker certified and am very good at documenting technical details. My previous job involved writing knowledge base articles for users to be able to easily troubleshoot their issues.

Learn more on the Gitcoin Issue Details page.

3) s0fty has started work.

I will test out the software to see what features it contains, then I will create a readme as according to the description.

Learn more on the Gitcoin Issue Details page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.