README (#22)

Author: fan-zhang-sv

packages/client/README.md

@@ -1,136 +1,31 @@
-# Coinbase Wallet SDK
+# Mobile Wallet Protocol - React Native Client
 
-## Coinbase Wallet SDK lets developers connect their dapps to Coinbase Wallet in the following ways:
+[![npm](https://img.shields.io/npm/v/@mobile-wallet-protocol/client.svg)](https://www.npmjs.com/package/@mobile-wallet-protocol/client)
 
-1. [Coinbase Smart Wallet](https://keys.coinbase.com/onboarding)
-   - [Docs](https://www.smartwallet.dev/)
-1. Coinbase Wallet mobile for [Android](https://play.google.com/store/apps/details?id=org.toshi&referrer=utm_source%3DWallet_LP) and [iOS](https://apps.apple.com/app/apple-store/id1278383455?pt=118788940&ct=Wallet_LP&mt=8)
-   - Desktop: Users can connect to your dapp by scanning a QR code
-   - Mobile: Users can connect to your mobile dapp through a deeplink to the dapp browser
-1. Coinbase Wallet extension for [Chrome](https://chrome.google.com/webstore/detail/coinbase-wallet-extension/hnfanknocfeofbddgcijnmhnfnkdnaad?hl=en) and [Brave](https://chromewebstore.google.com/detail/coinbase-wallet-extension/hnfanknocfeofbddgcijnmhnfnkdnaad?hl=en)
-   - Desktop: Users can connect by clicking the connect with extension option.
-
-### Installing Wallet SDK
-
-1. Check available versions:
-
-   ```shell
-     # yarn
-     yarn info @coinbase/wallet-sdk versions
-
-     # npm
-     npm view @coinbase/wallet-sdk versions
-   ```
-
-2. Install latest version:
-
-   ```shell
-   # yarn
-   yarn add @coinbase/wallet-sdk
-
-   # npm
-   npm install @coinbase/wallet-sdk
-   ```
-
-3. Check installed version:
-
-   ```shell
-   # yarn
-   yarn list @coinbase/wallet-sdk
-
-   # npm
-   npm list @coinbase/wallet-sdk
-   ```
-
-### Upgrading Wallet SDK
-
-Upgrade Coinbase Wallet SDK using yarn or npm.
-
-#### yarn/npm
-
-1. Compare installed version with latest:
-
-   ```shell
-   # yarn
-   yarn outdated @coinbase/wallet-sdk
+## Mobile Wallet Protocol Connects Your React Native App to Wallets
 
-   # npm
-   npm outdated @coinbase/wallet-sdk
-   ```
-
-2. Update to latest:
-
-   ```shell
-   # yarn
-   yarn upgrade @coinbase/wallet-sdk --latest
-
-   # npm
-   npm update @coinbase/wallet-sdk
-   ```
-
-### Basic Usage
-
-1. Initialize SDK
-
-   ```js
-   const sdk = new CoinbaseWalletSDK({
-     appName: 'SDK Playground',
-   });
-   ```
-
-2. Make web3 Provider
-
-   ```js
-   const provider = sdk.makeWeb3Provider();
-   ```
-
-3. Request accounts to initialize connection to wallet
-
-   ```js
-   const addresses = provider.request({
-     method: 'eth_requestAccounts',
-   });
-   ```
-
-4. Make more requests
-
-   ```js
-   provider.request('personal_sign', [
-     `0x${Buffer.from('test message', 'utf8').toString('hex')}`,
-     addresses[0],
-   ]);
-   ```
-
-5. Handle provider events
-
-   ```js
-   provider.on('connect', (info) => {
-     setConnect(info);
-   });
+### Supported Wallets
+1. [Coinbase Smart Wallet](https://keys.coinbase.com/onboarding)
+   - [Documentation](https://www.smartwallet.dev/)
 
-   provider.on('disconnect', (error) => {
-     setDisconnect({ code: error.code, message: error.message });
-   });
+### Wallets on the Roadmap
+1. Coinbase Wallet Mobile for [Android](https://play.google.com/store/apps/details?id=org.toshi&referrer=utm_source%3DWallet_LP) and [iOS](https://apps.apple.com/app/apple-store/id1278383455?pt=118788940&ct=Wallet_LP&mt=8)
+1. Other wallets adopting the Mobile Wallet Protocol
 
-   provider.on('accountsChanged', (accounts) => {
-     setAccountsChanged(accounts);
-   });
+### Integrate @MWP/client with Your App
 
-   provider.on('chainChanged', (chainId) => {
-     setChainChanged(chainId);
-   });
+Please refer to the [Smart Wallet Integration Guide](https://www.smartwallet.dev/guides/react-native-integration).
 
-   provider.on('message', (message) => {
-     setMessage(message);
-   });
-   ```
+### Developing Locally and Running the Test App
 
-### Developing locally and running the test dapp
+- Test app available [here](https://github.com/MobileWalletProtocol/smart-wallet-expo-example).
+- To develop locally, follow these steps:
 
-- The Coinbase Wallet SDK test dapp can be viewed here https://coinbase.github.io/coinbase-wallet-sdk/.
-- To run it locally follow these steps:
+   1. Fork this repository and clone it.
+   2. Fork the test app repository and clone it.
+   3. Develop for MWP Client.
+   4. From the root directory of the MWP Client repository, run `yarn build`.
+   5. From the root directory of the test app, run `yarn add "@mobile-wallet-protocol/client"@<your-path-to-MWP-client>`.
+   6. From the root directory of the test app, run `yarn ios` or `yarn android` to see the result.
 
-  1. Fork this repo and clone it
-  1. From the root dir run `yarn install`
-  1. From the root dir run `yarn dev`