update readme

Author: wesrisenmay-mx

example/README.md

@@ -4,52 +4,56 @@ This is a React Native application created with `npx react-native init
 MxMobileWidgetDemo --version 0.64.3`. The application's scheme is
 `mxwidgetsdkdemo` and was set with `npx uri-scheme add mxwidgetsdkdemo`.
 
-
 ## Running this application
 
 First, you will need to set up your environment so that you can run React
 Native apps. See https://reactnative.dev/docs/environment-setup for
 instructions on how to do that. Once your environment is setup, run the
 following commands:
 
-
 1. Clone this repository:
 
-  ```bash
-  git clone https://github.com/mxenabled/react-native-widget-sdk.git
-  cd react-native-widget-sdk
-  ```
+```bash
+git clone https://github.com/mxenabled/react-native-widget-sdk.git
+cd react-native-widget-sdk
+```
+
+2. [Setup react native](https://reactnative.dev/docs/set-up-your-environment)
 
-2. Install project dependencies:
+```
+  # Run the following command to help debug setup issues
+  npx react-native doctor
+```
 
-  ```bash
-  npm run example:install
-  ```
+3. Install project dependencies:
 
-3. Start the SSO proxy server:
+```bash
+npm run example:install
+```
 
-  ```bash
-  # This command will continue to run until it is manually stopped.
-  npm run example:server
-  ```
+4. Start the SSO proxy server:
 
-  The example application uses [`@mxenabled/sso-api-proxy`][sso_api_proxy] to
-  run a proxy server that talks to MX's Platform API. When the proxy server
-  first starts up, it will prompt you to enter the necessary API and user
-  settings in order to run. This configuration is then saved locally. See [this
-  page][sso_api_proxy_config] for more information on how to configure
-  `@mxenabled/sso-api-proxy`.
+```bash
+# This command will continue to run until it is manually stopped.
+npm run example:server
+```
 
-4. Finally, you can run the application on an iOS or Android simulator.
+The example application uses [`@mxenabled/sso-api-proxy`][sso_api_proxy] to
+run a proxy server that talks to MX's Platform API. When the proxy server
+first starts up, it will prompt you to enter the necessary API and user
+settings in order to run. This configuration is then saved locally. See [this
+page][sso_api_proxy_config] for more information on how to configure
+`@mxenabled/sso-api-proxy`.
 
-  ```bash
-  # This command will continue to run until it is manually stopped.
-  npm run example:start
+5. Finally, you can run the application on an iOS or Android simulator.
 
-  npm run example:ios     # Run application in an iOS simulator
-  npm run example:android # Run application in an Android simulator
-  ```
+```bash
+# This command will continue to run until it is manually stopped.
+npm run example:start
 
+npm run example:ios     # Run application in an iOS simulator
+npm run example:android # Run application in an Android simulator
+```
 
 [sso_api_proxy]: https://www.npmjs.com/package/@mxenabled/sso-api-proxy "@mxenabled/sso-api-proxy"
 [sso_api_proxy_config]: https://github.com/mxenabled/sso-api-proxy#configuration "Configuration"

example/ios/Podfile.lock

@@ -1728,65 +1728,65 @@ SPEC CHECKSUMS:
   fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120
   glog: 69ef571f3de08433d766d614c73a9838a06bf7eb
   hermes-engine: 8d2103d6c0176779aea4e25df6bb1410f9946680
-  RCT-Folly: 4464f4d875961fce86008d45f4ecf6cef6de0740
+  RCT-Folly: 34124ae2e667a0e5f0ea378db071d27548124321
   RCTDeprecation: 4191f6e64b72d9743f6fe1a8a16e89e868f5e9e7
   RCTRequired: 9bb589570f2bb3abc6518761e3fd1ad9b7f7f06c
   RCTTypeSafety: 1c1a8741c86df0a0ac1a99cf3fb0e29eedbc2c88
   React: b6810a201ee11e69ae8bfd4eb4aaab86610600bf
   React-callinvoker: d6c7898b63e6a2d37bc308f17c05be0ba3630b10
-  React-Core: 2fc97900b68e7568233698c6113ca9d64ed8b520
-  React-CoreModules: 2d68c251bc4080028f2835fa47504e8f20669a21
-  React-cxxreact: 5f233f8ac7ea4772e49462e0ab2b0a15a4f80ab7
+  React-Core: 411ef2293ba0c9147e04ee89324bc1575b38a089
+  React-CoreModules: 30c44229d249317498dac4a984925c56e06f61c2
+  React-cxxreact: 1ba92740ea3ed5be86898dec22f6548aa843da16
   React-debug: fd0ed8ecd5f8a23c7daf5ceaca8aa722a4d083fd
-  React-defaultsnativemodule: 10f0f8bc38d8dc7d2273572cd85ed0b71298ecdd
-  React-domnativemodule: bfef3dda59e7030b498d0d78628f4adf414ab8e4
-  React-Fabric: 3d0f5e2735d2f77a897ee684edeff7bb0e061919
-  React-FabricComponents: 68032a85a3c25c9c8d6ce676d8af9a85e2370f24
-  React-FabricImage: f8ac2df576703097b5b2f8d972b162cdca855aa3
+  React-defaultsnativemodule: 33038152921d2f3fdef66ba1f8ef32e9ee68a834
+  React-domnativemodule: 6e79b766cda4b3a447aa59aaf04473d257b0c5bb
+  React-Fabric: da5caca65022dcbbb95d12cebcde7770fdd44ff0
+  React-FabricComponents: 19e0eb8be8d8f2afa1a921705a87d8818eba14cf
+  React-FabricImage: 50df9e6aace1781cf23e130171631d7674b4072c
   React-featureflags: cf78861db9318ae29982fa8953c92d31b276c9ac
-  React-featureflagsnativemodule: d04eb5c3f0ac33fe70b060d97e8649bfd69c5f1e
-  React-graphics: 7572851bca7242416b648c45d6af87d93d29281e
-  React-hermes: 95c27801c60615345ee6256eafa6d597ce983b8b
-  React-idlecallbacksnativemodule: f5f0b760ec2739b30e315e1afee3dd3a5a93c3b6
-  React-ImageManager: aedf54d34d4475c66f4c3da6b8359b95bee904e4
-  React-jserrorhandler: 0c8949672a00f2a502c767350e591e3ec3d82fb3
-  React-jsi: d77bb442a4b0849063f2bd22d3c1fa71918713b7
-  React-jsiexecutor: 3b9c6334b7b0f42d4c4aae950132766e63a7809f
-  React-jsinspector: e1bb5816869507527c30213cc1ed60eae9e3e9c4
-  React-jsitracing: 3935b092f85bb1e53b8cf8a00f572413648af46b
-  React-logger: 4072f39df335ca443932e0ccece41fbeb5ca8404
-  React-Mapbuffer: 714f2fae68edcabfc332b754e9fbaa8cfc68fdd4
-  React-microtasksnativemodule: 4943ad8f99be8ccf5a63329fa7d269816609df9e
-  react-native-webview: 7aaf4bb5b2ec08901c821aceb4b55908ad012b04
+  React-featureflagsnativemodule: 3ff0c243e064a252293afb24aa0a6ee36b0149e4
+  React-graphics: 7ed2dc99f706228448b870882729a8303343b5a5
+  React-hermes: 167b427c2106b92ac47add9b35ca024d42453518
+  React-idlecallbacksnativemodule: 6b917d089d3beaa096c6c95bcb428c4577fe65de
+  React-ImageManager: 9970421c57b6458d3a4d6ce319c9067217c4882f
+  React-jserrorhandler: 6764a4b7abd617332fb0935c9ba63a6369207a15
+  React-jsi: 7713fae6d70c49a1b1b12d7e65ca62a50cd820d2
+  React-jsiexecutor: 67260e3eb3d1f3d3fd41ff15e89ce4027ae9c36a
+  React-jsinspector: a0f1febb0bcf5770ff135444a6afee7520ee42f7
+  React-jsitracing: bf77e00063522e4fd6d84fa129f0caaf360d275e
+  React-logger: 7e56c9eceafd7f45e98c16cb42ff3c9966c67119
+  React-Mapbuffer: e68dd904f0f3a84dd35989288ed3bcf5e37f9737
+  React-microtasksnativemodule: ca8806e64625be04b8f3d9f31f66508d02c42555
+  react-native-webview: 9a11224a769a9084ba99c867c199e32e7dca3f50
   React-nativeconfig: 4a9543185905fe41014c06776bf126083795aed9
-  React-NativeModulesApple: 0506da59fc40d2e1e6e12a233db5e81c46face27
+  React-NativeModulesApple: f6b6dc0998c945dd113858f1fc12e5e5f0da0990
   React-perflogger: 3bbb82f18e9ac29a1a6931568e99d6305ef4403b
-  React-performancetimeline: d15a723422ed500f47cb271f3175abbeb217f5ba
+  React-performancetimeline: 05c0372923c2f3a9e8a5ae954258f0436003bffb
   React-RCTActionSheet: cb2b38a53d03ec22f1159c89667b86c2c490d92d
-  React-RCTAnimation: 6836c87c7364f471e9077fda80b7349bc674be33
-  React-RCTAppDelegate: 2f11edfa7302451c792591f9a7838ca86cdcec34
-  React-RCTBlob: 516dbbd38397f5013394fdd1cc65408cc82e37a1
-  React-RCTFabric: b281a52c2b9726b0c64880e1535f2100013d5f7c
-  React-RCTImage: 1b2c2c1716db859ffff2d7a06a30b0ec5c677fc5
-  React-RCTLinking: 59c07577767e705b0ab95d11e5ad74c61bf2a022
-  React-RCTNetwork: f9a827e7d6bc428e0d99cd1fbe0427854354b8c1
-  React-RCTSettings: 614252fecc24840f61590c016aca1664a52cfb0f
-  React-RCTText: 424549f68867265aa25969f50e7b9bf8bd70ae55
-  React-RCTVibration: c8d156e6cce18f00b0310db7670fa997c7cda407
+  React-RCTAnimation: c8be4f58eabb487d6346247ee8e7bac434737ed7
+  React-RCTAppDelegate: d34bc2eeddc4d3f2a23275bf45e915d0d5df5284
+  React-RCTBlob: 7a64271f64a60390a2e73edecaca2735be8044ff
+  React-RCTFabric: dc41b0a646666b7e8db159c26eeda20af8b6328f
+  React-RCTImage: 4fb571875362a78ccc01aded76b94a71ae466b8b
+  React-RCTLinking: e825182eaf7f4047f6bb11bb6cd2ae5858008e66
+  React-RCTNetwork: 0e07b83395b6ff5016f7cea4ac99426a893a1438
+  React-RCTSettings: bd68792732f116994e992cf48e5bb70c4eb3910e
+  React-RCTText: c3cfce62ddb887cdd86403a6130a58a1f8fed9f3
+  React-RCTVibration: 32a10228b7affa8de6401dba6f0d73b5a8433342
   React-rendererconsistency: 993f54bb0df644df2922cd87ea55238d510d992b
-  React-rendererdebug: 7a8cbb632b68d666ad0fc01b3f9dc1a1bcc9a9f9
+  React-rendererdebug: 9cd1f3e6d12c1d9b99fce6ceb373495b29b3d9ee
   React-rncore: 1df26fe0ae861c599f9f2896f45e8834ef4b85f9
-  React-RuntimeApple: b5b14b09e3be4058f9fe7ab4925e1ee343f03310
-  React-RuntimeCore: 2073fb33da2aec6ce6c1c9d3d53898ed1f1d806d
+  React-RuntimeApple: 5fb9053ae46ec14407f24547afd903ec8f0c0b9a
+  React-RuntimeCore: f6af8417106c1ce5b494edd99e86b0d0069ad6c3
   React-runtimeexecutor: 9a668b94ad5d93755443311715bd57680330286a
-  React-RuntimeHermes: b37c62718d6920ac2958a0052bdc1b01aca842b8
-  React-runtimescheduler: e25750a18cbb7469e0513f1ace834d14e8c1a202
-  React-utils: f2afa6acd905ca2ce7bb8ffb4a22f7f8a12534e8
-  ReactCodegen: ff95a93d5ab5d9b2551571886271478eaa168565
-  ReactCommon: 289214026502e6a93484f4a46bcc0efa4f3f2864
+  React-RuntimeHermes: 6c6053fb5aca5558b071cfbce2868ca50a3b8fc7
+  React-runtimescheduler: 5d1a32712d441c38e6d5815069e1810d38ed26f7
+  React-utils: 3c815e7d3abb801930a3df2db870c92855429fea
+  ReactCodegen: 3d11bcf0cac47a77042a3476a1c2f7058bfd6880
+  ReactCommon: c65f7049a542669dcc7bff6b7a8071a039c7d0dd
   SocketRocket: abac6f5de4d4d62d24e11868d7a2f427e0ef940d
-  Yoga: 1354c027ab07c7736f99a3bef16172d6f1b12b47
+  Yoga: 4ef80d96a5534f0e01b3055f17d1e19a9fc61b63
 
 PODFILE CHECKSUM: d650b9b2283f9bbc210e0e2f8bda4e5ed0ca7725
 
-COCOAPODS: 1.15.2
+COCOAPODS: 1.16.2