fix: added comments and mock examplers in packages//README

Author: finoaamukherjee

packages/finoaconnect/README.md

@@ -20,6 +20,20 @@ const onboard = Onboard({
   ]
 })
 
+// alternatively to connect to a localised development environment
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    finoaConnectModule([
+      {
+        labelSuffix: 'localhost',
+        url: 'http://localhost:8080',
+      }
+    ])
+    //... other wallets
+  ]
+})
+
 const connectedWallets = await onboard.connectWallet()
 console.log(connectedWallets)
 ```

packages/finoaconnect/src/index.ts

@@ -1,6 +1,10 @@
 import { FinoaEIP1193Provider } from '@finoa/finoa-connect-sdk'
 import type { Chain, WalletInit } from '@web3-onboard/common'
 
+/** Optional object provided to the initiation of the wallet connector. 
+ * When not included, the wallet connector service connects to FinoaConnect production systems.
+ * @field {url} URL of the FinoaConnect backend systems to be used
+ * @field {labelSuffix} arbitrary string label to denote the context of the URL field  */
 export interface FinoaWalletOption {
   url?: string
   labelSuffix?: string

yarn.lock

@@ -1857,6 +1857,11 @@
   dependencies:
     keccak "^3.0.0"
 
+"@finoa/finoa-connect-sdk@^1.0.2":
+  version "1.0.2"
+  resolved "https://registry.yarnpkg.com/@finoa/finoa-connect-sdk/-/finoa-connect-sdk-1.0.2.tgz#17dc743f1bb93bb365254f4ab262c1ebaf05fd80"
+  integrity sha512-RMpJjsic+xKz6CnasF+/JvMvtcfQphFjCS6H7OdPj2FSXCyimqVXMHbTzUFONKITgZO6iolxT+UY99ujEVHv0w==
+
 "@formatjs/ecma402-abstract@1.11.3":
   version "1.11.3"
   resolved "https://registry.yarnpkg.com/@formatjs/ecma402-abstract/-/ecma402-abstract-1.11.3.tgz#f25276dfd4ef3dac90da667c3961d8aa9732e384"
@@ -15060,16 +15065,16 @@ typescript@*, typescript@^4.5.5:
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.5.5.tgz#d8c953832d28924a9e3d37c73d729c846c5896f3"
   integrity sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==
 
+typescript@5.1.6, typescript@^5.1.6:
+  version "5.1.6"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.1.6.tgz#02f8ac202b6dad2c0dd5e0913745b47a37998274"
+  integrity sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==
+
 typescript@^4.6.2:
   version "4.6.4"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.6.4.tgz#caa78bbc3a59e6a5c510d35703f6a09877ce45e9"
   integrity sha512-9ia/jWHIEbo49HfjrLGfKbZSuWo9iTMwXO+Ca3pRsSpbsMbc7/IU8NKdCZVRRBafVPGnoJeFL76ZOAA84I9fEg==
 
-typescript@^5.1.6:
-  version "5.1.6"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.1.6.tgz#02f8ac202b6dad2c0dd5e0913745b47a37998274"
-  integrity sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==
-
 typescript@^5.2.2:
   version "5.2.2"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78"