diff --git a/.github/docs/development.md b/.github/docs/development.md new file mode 100644 index 00000000..4bfc36f1 --- /dev/null +++ b/.github/docs/development.md @@ -0,0 +1,39 @@ +# Development + +## Workspace setup + +Install dependencies from the repository's root directory (this will also set up the example project workspace): + +```bash +yarn +``` + +## ProjectID setup + +The example project has `app.config.js` file. Add your Project ID there + +``` json +extra: { + ... + PROJECT_ID: process.env.PROJECT_ID || "YOUR_PROJECT_ID" +}, +``` + +or add it before running commands in your terminal: + +```bash +PROJECT_ID="YOUR_PROJECT_ID" yarn example ios +``` + + +To create your ProjectID, head to [cloud.walletconnect.com](https://cloud.walletconnect.com/) + +## Commands + +Execute all commands from the root. + +- `yarn example ios` - Run the example project in an iOS simulator. +- `yarn example android` - Run the example project in an Android simulator. +- `yarn lint` - Run the linter. +- `yarn typecheck` - Run typescript checks. +- `yarn test` - Run jest tests. diff --git a/README.md b/README.md index 67524db4..e61fb9e1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -# @web3modal/react-native +# Web3Modal SDK for React Native -Web3Modal SDK for React-Native +Your on-ramp to web3 multichain. Web3Modal is a versatile library that makes it super easy to connect users with your Dapp and start interacting with the blockchain. + +### ๐Ÿ“š [Documentation](https://docs.walletconnect.com/2.0/reactnative/web3modal/Installation) + +### ๐Ÿ”Ž [Examples](https://github.com/WalletConnect/react-native-examples/tree/main/dapps/v2Explorer) + +### ๐Ÿงช [Laboratory](https://lab.web3modal.com) + +### ๐Ÿ”— [Website](https://web3modal.com) + + +## Development + +Please follow [developer docs](./.github/docs/development.md) to set up web3modal locally.