feat: document update (#98)

crypto-com · Aug 19, 2022 · 4dd9911 · 4dd9911
1 parent 141ce84
commit 4dd9911
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 15 deletions.
diff --git a/packages/provider/README.md b/packages/provider/README.md
@@ -24,16 +24,19 @@ the global variable is: `DeFiConnectProvider`
 import { DeFiConnectProvider } from '@deficonnect/provider'
 
 const provider = new DeFiConnectProvider({
-  appName: 'your app name'
-  chainType: 'eth'
-  chainId: '28' // for eth is 1
+  appName: 'your app name',
+  chainType: 'eth', // currently support 'eth' | 'cosmos'
+  chainId: '25', // for eth is 1
   rpcUrls: {
     1: 'https://mainnet.infura.io/v3/INFURA_API_KEY',
-    28: 'https://evm-cronos.crypto.org/',
-  }
+    25: 'https://evm-cronos.crypto.org/',
+  },
 })
 ```
 
+> if you want to support cosmos like chain, please read: [@deficonnect/cosmos-signer](https://github.com/crypto-com/deficonnect-monorepo/tree/develop/packages/cosmos-signer)
+> cosmos support: [docs](https://github.com/crypto-com/deficonnect-monorepo/wiki/Chrome-Extension-Wallet-Integration#cosmos-rpc-api)
+
 ### Provider(EIP-1193)
 ```typescript
 interface RequestArguments {

diff --git a/packages/web3-connector/README.md b/packages/web3-connector/README.md
@@ -21,16 +21,19 @@ the global variable is: `DeFiWeb3Connector`
 ```javascript
 const connector = new DeFiWeb3Connector({
   supportedChainIds: [1],
-  appName: 'your app name'
-  chainType: 'eth'
-  chainId: '28' // for eth is 1
+  appName: 'your app name',
+  chainType: 'eth', // only support 'eth' for DeFiWeb3Connector
+  chainId: '25', // for eth is 1
   rpcUrls: {
     1: 'https://mainnet.infura.io/v3/INFURA_API_KEY',
-    28: 'https://evm-cronos.crypto.org/',
-  }
+    25: 'https://evm-cronos.crypto.org/',
+  },
 })
+
 ```
 
+> if you want to support cosmos like chain, please use: [@deficonnect/provider](https://github.com/crypto-com/deficonnect-monorepo/tree/develop/packages/cosmos-signer) directly
+
 ## Usage
 
 ### connect wallet
@@ -43,13 +46,13 @@ import { DeFiWeb3Connector } from '@deficonnect/web3-connector'
 
 const connector = new DeFiWeb3Connector({
   supportedChainIds: [1],
-  appName: 'your app name'
-  chainType: 'eth'
-  chainId: '28' // for eth is 1
+  appName: 'your app name',
+  chainType: 'eth', // only support 'eth' for DeFiWeb3Connector
+  chainId: '25', // for eth is 1
   rpcUrls: {
     1: 'https://mainnet.infura.io/v3/INFURA_API_KEY',
-    28: 'https://evm-cronos.crypto.org/',
-  }
+    25: 'https://evm-cronos.crypto.org/',
+  },
 })
 connector.activate()
 ```