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.

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

Jump to bottom

Update README.md #300

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Update README.md #300

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0f0ca0
Update README.md
AgneCaunt Oct 22, 2024
afcad5b
Update README.md
AgneCaunt Oct 22, 2024
4075a3e
Merge branch 'master' into AgneCaunt-patch-1
AgneCaunt Oct 23, 2024
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Dock Wallet SDK

Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to a lack of WebAssembly support.
The [Wallet SDK](https://github.com/docknetwork/react-native-sdk) enables you to build a Verifiable Credentials wallet inside your app and allows your users to receive, store, and manage their DOCK tokens too. This was built for mobile applications with added support for Polkadot-JS.

To use the wallet-sdk, all you need to do is wrap your app in a `WalletSDKProvider` and start building your wallet.

Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to the lack of WebAssembly support.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment feel incomplete. I was expecting a follow-up sentence explaining how we get around that limitation by using a WebView

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just added the comments that we had in our previous wallet SDK documents. Feel free to add missing comments

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mike-parkhill I have moved the sentences around to address your comments, but feel free to change. The goal is to have something that is correct for now and get the examples synced as well and if a more extensive description is needed I can add that later.

The Dock Wallet SDK handles all the Polkadot Web Assembly in a WebView, sending messages to the React Native thread through a JSON RPC layer.

All you need to do is wrap your app in a `WalletSDKProvider` and start building your Polkadot wallet.
Dock Mobile SDK supports devices that have Android 8.1 or higher and iOS 11 or higher.

## Installation
```js
Expand Down
Loading