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

Example ReadME #193

Open
rennylangat opened this issue Sep 25, 2023 · 1 comment
Open

Example ReadME #193

rennylangat opened this issue Sep 25, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@rennylangat
Copy link

In the example provided, one could easily get confused. Even for someone that used V1 like me, I still get confused since the WalletConnectV2 docs and the package docs kind of differ.
Moreover, all functions have been crumbled up yet some could not have a use-case for a user. I think creating the documentation in a use-case oriented manner could help alleviate this.
In my somewhat limited experience with this package, I have identified two main use-cases:

  1. Balance inquiry, Sending Assets on the ETH network (Address to Address Tx).
  2. Smart Contract Function interactions (ETH network, Layer 1's & Layer 2's network).

In my suggestion having the docs showcase how the two can be achieved; and as a plus show the difference between V1 and V2 when achieving these functionalities will greatly reduce the confusion.

@quetool
Copy link
Collaborator

quetool commented Sep 28, 2023

Hello @rennylangat! That's a good feedback! We'll be considering it! Thanks!

@quetool quetool self-assigned this Sep 28, 2023
@quetool quetool added the documentation Improvements or additions to documentation label Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants