|
1 | 1 | # Truvera Wallet SDK |
2 | 2 |
|
3 | | -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. |
| 3 | +The [Wallet SDK](https://github.com/docknetwork/wallet-sdk) enables you to build an identity wallet inside your app and allows your users to receive, store, and manage verifiable credentials. |
4 | 4 |
|
5 | 5 | To use the wallet-sdk, all you need to do is wrap your app in a `WalletSDKProvider` and start building your wallet. |
6 | 6 |
|
7 | | -Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to the lack of WebAssembly support. |
8 | | -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. |
9 | | - |
10 | | -Truvera Mobile SDK supports: |
| 7 | +The Truvera Mobile SDK supports: |
11 | 8 | - Devices that have Android 8.1 or higher and iOS 11 or higher. |
12 | 9 | - Minimum supported version of Node.js is 20.2.0 |
13 | 10 |
|
14 | 11 | ## Installation |
15 | 12 | ```js |
16 | | -yarn add @docknetwork/wallet-sdk-core |
17 | | -yarn add @docknetwork/wallet-sdk-react-native |
| 13 | +npm install @docknetwork/wallet-sdk-core |
| 14 | +npm install @docknetwork/wallet-sdk-react-native |
18 | 15 |
|
19 | 16 | ``` |
20 | 17 | **There are some scripts and additional dependencies required.** |
21 | | -Please check our [examples](/examples) folder for detailed steps. |
| 18 | +Please check our [examples](https://github.com/docknetwork/wallet-sdk/tree/master/examples) folder for detailed steps. |
22 | 19 |
|
23 | 20 | ## React Native Example |
24 | | -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. |
25 | | -Notice that the all documents are accessible through the `documents` object. |
| 21 | +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. |
| 22 | +Notice that all documents are accessible through the `documents` object. |
26 | 23 |
|
27 | 24 | ```js |
28 | 25 | import {Box, Button, NativeBaseProvider, Text} from 'native-base'; |
@@ -67,20 +64,20 @@ export default App; |
67 | 64 |
|
68 | 65 | ``` |
69 | 66 |
|
70 | | -## Running on other platforms |
71 | | - |
72 | | -Check the following repository for detailed examples for running the Truvera Wallet SDK on NodeJS, Web, and Flutter. |
73 | | - |
74 | | -[See the examples](https://github.com/docknetwork/wallet-sdk/tree/master/examples) |
75 | 67 |
|
| 68 | +## Documentation |
76 | 69 |
|
77 | | -## Docs |
| 70 | +The [Truvera Documentation Portal](https://docs.truvera.io) aggregates documentation for all components of the Truvera Platform. Documentation specific to the Wallet SDK is mirrored from [the GitHub repository](https://github.com/docknetwork/wallet-sdk). Node package reference documentation is also published on [GitHub.io](https://docknetwork.github.io/wallet-sdk/). |
78 | 71 |
|
79 | | -For more details you can check the [getting started guide](https://github.com/docknetwork/wallet-sdk/blob/master/docs/getting-started.md) |
| 72 | +For more details you should read [the getting started guide](https://github.com/docknetwork/wallet-sdk/blob/master/docs/getting-started.md). |
80 | 73 |
|
81 | | -[See the Github repository](https://docknetwork.github.io/wallet-sdk/) |
82 | 74 |
|
83 | | -## Features |
| 75 | +### Key Features |
84 | 76 | - [Biometric Plugin](https://github.com/docknetwork/wallet-sdk/blob/master/docs/biometric-plugin.md) |
85 | 77 | - [Ecosystem Tools](https://github.com/docknetwork/wallet-sdk/blob/master/docs/ecosystem-tools.md) |
86 | 78 | - [Cloud Wallet](https://github.com/docknetwork/wallet-sdk/blob/master/docs/cloud-wallet.md) |
| 79 | + |
| 80 | + |
| 81 | +### Running on other platforms |
| 82 | + |
| 83 | +[The examples directory](https://github.com/docknetwork/wallet-sdk/tree/master/examples) contains detailed examples for running the Truvera Wallet SDK on NodeJS, Web, and Flutter. |
0 commit comments