Skip to content

Commit b85a620

Browse files
committed
updated readme
1 parent 514da8a commit b85a620

2 files changed

Lines changed: 78 additions & 14 deletions

File tree

README.md

Lines changed: 77 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,93 @@
1-
# kycdao-mobile
2-
React Native library of kycDAO for iOS and Android
3-
## Installation
1+
# ``KycDao``
2+
3+
Composable Compliance
4+
5+
## Overview
6+
7+
React Native SDK of [kycDAO](https://kycdao.xyz/)
8+
9+
With the kycDAO React Native SDK you can
10+
- check whether a wallet address have been verified and has a valid token.
11+
- go through the verification process from identification till kycNFT minting.
12+
13+
The SDK can be used by
14+
- Wallets
15+
- DApps
16+
- Web2 Applications
17+
18+
### Documentation
19+
20+
The documentation of the SDK is available [here](https://docs.kycdao.xyz/mobilesdk/react-native-sdk/).
21+
22+
### Installation
23+
24+
#### NPM
425

526
```sh
627
npm install kycdao-mobile
728
```
829

9-
## Usage
30+
#### Importing to source file
31+
32+
Add an import at the top of your source file
33+
34+
With namespace import
1035

1136
```js
12-
import { multiply } from "kycdao-mobile";
37+
import * as KycDao from 'kycdao-mobile';
38+
```
1339

14-
// ...
40+
or with named import
1541

16-
const result = await multiply(3, 7);
42+
```js
43+
import {
44+
WalletConnectManager,
45+
WalletConnectSession,
46+
VerificationManager,
47+
IdentityFlowResult,
48+
VerificationStatus,
49+
PersonalData,
50+
VerificationType,
51+
NetworkConfig,
52+
WCSessionError,
53+
Configuration,
54+
KycDaoEnvironment,
55+
BaseWalletSession,
56+
MintingTransactionResult
57+
} from 'kycdao-mobile';
1758
```
1859

19-
## Contributing
60+
That's it. You can start coding.
61+
62+
### Configuration
63+
64+
Set up the environment and [Configure the SDK](https://docs.kycdao.xyz/mobilesdk/react-native-sdk/configuresdk/) for your needs
65+
66+
> Important: It is recommended that you bring your own nodes when using the SDK, you can check the [Configure SDK](https://docs.kycdao.xyz/mobilesdk/react-native-sdk/configuresdk/) article to see how to set your own RPC URLs for your supported networks.
67+
68+
### Example
69+
70+
An example React Native project for a DApp implementation is available in the [example](https://github.com/kycdao/react-native/tree/main/example) folder.
71+
72+
### Integration
73+
74+
Learn the [Wallet Integration](https://docs.kycdao.xyz/mobilesdk/react-native-sdk/walletintegration/) or [DApp Integration](https://docs.kycdao.xyz/mobilesdk/react-native-sdk/dappandweb2/) specific steps to use the SDK
75+
76+
Help your users getting verified by implementing the [Onboarding](https://docs.kycdao.xyz/mobilesdk/react-native-sdk/onboarding/) flow
77+
78+
Deep dive into the SDK by visiting the [API documentation](https://docs.kycdao.xyz/mobilesdk/react-native-sdk/api/)
79+
80+
### Supported networks
2081

21-
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
82+
Main | Test
83+
--- | ---
84+
Polygon | Polygon Mumbai
85+
Celo | Celo Alfajores
2286

23-
## License
2487

25-
MIT
88+
### Other platforms
2689

27-
---
90+
The SDK is also available on other mobile platforms (Android, iOS) and Web.
91+
You can browse our available SDKs [here](https://docs.kycdao.xyz/)
2892

29-
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
93+
You can learn about [smart contract gating here](https://docs.kycdao.xyz/smartcontracts/onchaingating/)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "kycdao-mobile",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "test",
55
"main": "lib/commonjs/index",
66
"module": "lib/module/index",

0 commit comments

Comments
 (0)