WalletConnect / kotlin-walletconnect-lib

library to use WalletConnect with Kotlin or Java
MIT License
156 stars 98 forks source link

Add documentation & example #7

Open pedrouid opened 5 years ago

pedrouid commented 5 years ago

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

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 commented 5 years ago

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 commented 5 years ago

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.

rmeissner commented 5 years ago

Note: there is a branch with a simple dapp as an example: https://github.com/WalletConnect/kotlin-walletconnect-lib/tree/sample_native_dapp

pedrouid commented 5 years ago

Thanks for the tip @rmeissner! 🙌

Please check out the branch sample_native_dapp which already includes an Example to bootstrap your PRs. cc @aerophile @ssd4130 @s0fty

VvoidVano commented 5 years ago

crashed when run the sample, it's about localhost something, do I need to build server as well ? could you provide a demo video and more details in documentations? thanks @rmeissner @pedrouid

adrianhacker-pdx commented 4 years ago

@pedrouid is the bounty still available to work on? Gitcoin says it's expired. Let me know.

pedrouid commented 4 years ago

Hey @adrianhacker-pdx, yes this bounty is still available. Going to renew it on Gitcoin 👍

pedrouid commented 4 years ago

I've updated the expiration, feel free to visit the issue on Gitcoin and signal that you are working on it.

https://gitcoin.co/issue/WalletConnect/kotlin-walletconnect-lib/7/2966

tomtaila-wesayhi commented 3 years ago

This is useless without documentation

gitcoinbot commented 3 years ago

Issue Status: 1. Open 2. Cancelled


The funding of 50.0 DAI (50.0 USD @ $1.0/DAI) attached to this issue has been cancelled by the bounty submitter