Skip to content

Commit cb2869a

Browse files
authored
Merge pull request #58 from docknetwork/sync/heads/master_ea655ce13859d06b82b39d990a4ccd1c4ef55bb7
Merge pull request #416 from docknetwork/DCKA-4877-setup-up-js-doc-builds-in-ci-cd Dcka 4877 setup up js doc builds in ci cd
2 parents 0f1c957 + 7e9b664 commit cb2869a

File tree

4 files changed

+665
-15
lines changed

4 files changed

+665
-15
lines changed

developer-documentation/wallet-sdk/README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,27 @@
1-
# Wallet SDK
1+
# Truvera Wallet SDK
22

33
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.
44

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

7-
Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to the lack of WebAssembly support.\
7+
Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to the lack of WebAssembly support.
88
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.
99

1010
Truvera Mobile SDK supports:
11-
12-
* Devices that have Android 8.1 or higher and iOS 11 or higher.
13-
* Minimum supported version of Node.js is 20.2.0
11+
- Devices that have Android 8.1 or higher and iOS 11 or higher.
12+
- Minimum supported version of Node.js is 20.2.0
1413

1514
## Installation
16-
1715
```js
1816
yarn add @docknetwork/wallet-sdk-core
1917
yarn add @docknetwork/wallet-sdk-react-native
2018

2119
```
22-
23-
**There are some scripts and additional dependencies required.**\
24-
Please check our [examples](../../examples/) folder for detailed steps.
20+
**There are some scripts and additional dependencies required.**
21+
Please check our [examples](/examples) folder for detailed steps.
2522

2623
## React Native Example
27-
28-
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.\
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.
2925
Notice that the all documents are accessible through the `documents` object.
3026

3127
```js
@@ -77,14 +73,14 @@ Check the following repository for detailed examples for running the Truvera Wal
7773

7874
[See the examples](https://github.com/docknetwork/wallet-sdk/tree/master/examples)
7975

76+
8077
## Docs
8178

8279
For more details you can check the [getting started guide](https://github.com/docknetwork/wallet-sdk/blob/master/docs/getting-started.md)
8380

8481
[See the Github repository](https://docknetwork.github.io/wallet-sdk/)
8582

8683
## Features
87-
88-
* [Biometric Plugin](https://github.com/docknetwork/wallet-sdk/blob/master/docs/biometric-plugin.md)
89-
* [Ecosystem Tools](https://github.com/docknetwork/wallet-sdk/blob/master/docs/ecosystem-tools.md)
90-
* [Cloud Wallet](https://github.com/docknetwork/wallet-sdk/blob/master/docs/cloud-wallet.md)
84+
- [Biometric Plugin](https://github.com/docknetwork/wallet-sdk/blob/master/docs/biometric-plugin.md)
85+
- [Ecosystem Tools](https://github.com/docknetwork/wallet-sdk/blob/master/docs/ecosystem-tools.md)
86+
- [Cloud Wallet](https://github.com/docknetwork/wallet-sdk/blob/master/docs/cloud-wallet.md)

developer-documentation/wallet-sdk/api/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)