diff --git a/developer-documentation/wallet-sdk/README.md b/developer-documentation/wallet-sdk/README.md index 2b32277..ca3022e 100644 --- a/developer-documentation/wallet-sdk/README.md +++ b/developer-documentation/wallet-sdk/README.md @@ -1,31 +1,27 @@ -# Wallet SDK +# Truvera Wallet SDK The [Wallet SDK](https://github.com/docknetwork/wallet-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.\ +Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to the lack of WebAssembly support. The Truvera Wallet SDK handles all the Polkadot Web Assembly in a WebView, sending messages to the React Native thread through a JSON RPC layer. Truvera Mobile SDK supports: - -* Devices that have Android 8.1 or higher and iOS 11 or higher. -* Minimum supported version of Node.js is 20.2.0 +- Devices that have Android 8.1 or higher and iOS 11 or higher. +- Minimum supported version of Node.js is 20.2.0 ## Installation - ```js yarn add @docknetwork/wallet-sdk-core yarn add @docknetwork/wallet-sdk-react-native ``` - -**There are some scripts and additional dependencies required.**\ -Please check our [examples](../../examples/) folder for detailed steps. +**There are some scripts and additional dependencies required.** +Please check our [examples](/examples) folder for detailed steps. ## React Native Example - -The following example will create a wallet and allow the user to add credentials to it. Displaying the count of documents added to the wallet.\ +The following example will create a wallet and allow the user to add credentials to it. Displaying the count of documents added to the wallet. Notice that the all documents are accessible through the `documents` object. ```js @@ -77,6 +73,7 @@ Check the following repository for detailed examples for running the Truvera Wal [See the examples](https://github.com/docknetwork/wallet-sdk/tree/master/examples) + ## Docs For more details you can check the [getting started guide](https://github.com/docknetwork/wallet-sdk/blob/master/docs/getting-started.md) @@ -84,7 +81,6 @@ For more details you can check the [getting started guide](https://github.com/do [See the Github repository](https://docknetwork.github.io/wallet-sdk/) ## Features - -* [Biometric Plugin](https://github.com/docknetwork/wallet-sdk/blob/master/docs/biometric-plugin.md) -* [Ecosystem Tools](https://github.com/docknetwork/wallet-sdk/blob/master/docs/ecosystem-tools.md) -* [Cloud Wallet](https://github.com/docknetwork/wallet-sdk/blob/master/docs/cloud-wallet.md) +- [Biometric Plugin](https://github.com/docknetwork/wallet-sdk/blob/master/docs/biometric-plugin.md) +- [Ecosystem Tools](https://github.com/docknetwork/wallet-sdk/blob/master/docs/ecosystem-tools.md) +- [Cloud Wallet](https://github.com/docknetwork/wallet-sdk/blob/master/docs/cloud-wallet.md)