From 6e7332ec695370fb774b81628b6502bf70b90c58 Mon Sep 17 00:00:00 2001 From: Mohammad Shahbaz Alam Date: Tue, 9 Apr 2024 15:41:41 +0530 Subject: [PATCH] Update MPC CoreKit Web Readme's --- .../mpc-core-kit-popup-flow-example/README.md | 14 +++---- .../README.md | 38 ++++++++++++++++++- .../README.md | 12 +++--- .../README.md | 12 +++--- .../mpc-core-kit-nextjs-quick-start/README.md | 16 ++++---- .../mpc-core-kit-react-quick-start/README.md | 12 +++--- .../mpc-core-kit-vue-quick-start/README.md | 16 ++++---- 7 files changed, 78 insertions(+), 42 deletions(-) diff --git a/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-popup-flow-example/README.md b/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-popup-flow-example/README.md index 77197116..43036129 100644 --- a/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-popup-flow-example/README.md +++ b/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-popup-flow-example/README.md @@ -1,28 +1,28 @@ -# Web3Auth MPC Beta React Popup Example +# Web3Auth MPC CoreKit Web [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) React Popup Example -[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey) +[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) [![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) [Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. -This example demonstrates how to use Web3Auth's tKey MPC Beta in a React environment. +This example demonstrates how to use Web3Auth's MPC CoreKit Web SDK in a React environment. ## How to Use ### Download Manually ```bash -npx degit Web3Auth/web3auth-core-kit-examples/tkey/tkey-mpc-beta-react-popup-example w3a-tkey-mpc-beta-example +npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-popup-flow-example w3a-mpc-core-kit-popup-flow-example ``` Install & Run: ```bash -cd w3a-tkey-mpc-beta-example +cd w3a-mpc-core-kit-popup-flow-example npm install npm run start # or -cd w3a-tkey-mpc-beta-example +cd w3a-mpc-core-kit-popup-flow-example yarn yarn start ``` @@ -34,4 +34,4 @@ yarn start - [Guides](https://web3auth.io/docs/content-hub?type=guides) - [SDK / API References](https://web3auth.io/docs/sdk) - [Pricing](https://web3auth.io/pricing.html) -- [Community Portal](https://community.web3auth.io) \ No newline at end of file +- [Community Portal](https://community.web3auth.io) diff --git a/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-redirect-flow-example/README.md b/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-redirect-flow-example/README.md index fea8afd5..04cdba5e 100644 --- a/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-redirect-flow-example/README.md +++ b/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-redirect-flow-example/README.md @@ -1 +1,37 @@ -# MPC Core Kit React Redirect Example \ No newline at end of file +# Web3Auth MPC CoreKit Web [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) React Redirect Example + +[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) +[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) + +[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. + +This example demonstrates how to use Web3Auth's MPC CoreKit Web SDK in a React environment. + +## How to Use + +### Download Manually + +```bash +npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-web/implicit-flow-examples/mpc-core-kit-redirect-flow-example w3a-mpc-core-kit-redirect-flow-example +``` + +Install & Run: + +```bash +cd w3a-mpc-core-kit-redirect-flow-example +npm install +npm run start +# or +cd w3a-mpc-core-kit-redirect-flow-example +yarn +yarn start +``` + +## Important Links + +- [Website](https://web3auth.io) +- [Docs](https://web3auth.io/docs) +- [Guides](https://web3auth.io/docs/content-hub?type=guides) +- [SDK / API References](https://web3auth.io/docs/sdk) +- [Pricing](https://web3auth.io/pricing.html) +- [Community Portal](https://community.web3auth.io) diff --git a/mpc-core-kit-web/mpc-core-kit-aggregate-verifier-example/README.md b/mpc-core-kit-web/mpc-core-kit-aggregate-verifier-example/README.md index f0f8c7e6..378e574f 100644 --- a/mpc-core-kit-web/mpc-core-kit-aggregate-verifier-example/README.md +++ b/mpc-core-kit-web/mpc-core-kit-aggregate-verifier-example/README.md @@ -1,28 +1,28 @@ -# Web3Auth MPC Beta React Aggregate Verifier Popup Example +# Web3Auth MPC CoreKit Web [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) React Aggregate Verifier Example -[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey) +[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) [![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) [Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. -This example demonstrates how to use Web3Auth's tKey MPC Beta in a React environment. +This example demonstrates how to use Web3Auth's MPC CoreKit Web SDK in a React environment. ## How to Use ### Download Manually ```bash -npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit/mpc-core-kit-react-popup-aggregate-example w3a-tkey-mpc-beta-aggregate-example +npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-web/mpc-core-kit-aggregate-verifier-example w3a-mpc-core-kit-aggregate-verifier-example ``` Install & Run: ```bash -cd w3a-tkey-mpc-beta-aggregate-example +cd w3a-mpc-core-kit-aggregate-verifier-example npm install npm run start # or -cd w3a-tkey-mpc-beta-aggregate-example +cd w3a-mpc-core-kit-aggregate-verifier-example yarn yarn start ``` diff --git a/mpc-core-kit-web/quick-starts/mpc-core-kit-angular-quick-start/README.md b/mpc-core-kit-web/quick-starts/mpc-core-kit-angular-quick-start/README.md index 3e93e1f1..b24b61a9 100644 --- a/mpc-core-kit-web/quick-starts/mpc-core-kit-angular-quick-start/README.md +++ b/mpc-core-kit-web/quick-starts/mpc-core-kit-angular-quick-start/README.md @@ -1,28 +1,28 @@ -# Web3Auth (`@web3auth/modal`) x EVM x Angular +# Web3Auth MPC CoreKit Web [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) QuickStart - Angular -[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/pnp/web/modal) +[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) [![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) [Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. -This example demonstrates how to use Web3Auth with EVM in Angular. +This example demonstrates how to use Web3Auth's MPC CoreKit Web SDK in an Angular application. ## How to Use ### Download Manually ```bash -npx degit Web3Auth/web3auth-pnp-examples/web-modal-sdk/evm/angular-evm-modal-example w3a-modal-evm-angular +npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-web/quick-starts/mpc-core-kit-angular-quick-start w3a-mpc-core-kit-angular-quick-start ``` Install & Run: ```bash -cd w3a-modal-evm-angular +cd w3a-mpc-core-kit-angular-quick-start npm install npm run start # or -cd w3a-modal-evm-angular +cd w3a-mpc-core-kit-angular-quick-start yarn yarn start ``` diff --git a/mpc-core-kit-web/quick-starts/mpc-core-kit-nextjs-quick-start/README.md b/mpc-core-kit-web/quick-starts/mpc-core-kit-nextjs-quick-start/README.md index 6ed33b70..7c1d3430 100644 --- a/mpc-core-kit-web/quick-starts/mpc-core-kit-nextjs-quick-start/README.md +++ b/mpc-core-kit-web/quick-starts/mpc-core-kit-nextjs-quick-start/README.md @@ -1,30 +1,30 @@ -# Web3Auth (`@web3auth/modal`) x EVM x Next.js +# Web3Auth MPC CoreKit Web [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) QuickStart - Next.js -[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/pnp/web/modal) +[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) [![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) [Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. -This example demonstrates how to use Web3Auth with EVM in Next.js +This example demonstrates how to use Web3Auth's MPC CoreKit Web SDK in a Next.js application. ## How to Use ### Download Manually ```bash -npx degit Web3Auth/web3auth-pnp-examples/web-modal-sdk/evm/nextjs-evm-modal-example w3a-modal-evm-nextjs +npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-web/quick-starts/mpc-core-kit-nextjs-quick-start w3a-mpc-core-kit-nextjs-quick-start ``` Install & Run: ```bash -cd w3a-modal-evm-nextjs +cd w3a-mpc-core-kit-nextjs-quick-start npm install -npm run dev +npm run start # or -cd w3a-modal-evm-nextjs +cd w3a-mpc-core-kit-nextjs-quick-start yarn -yarn dev +yarn start ``` ## Important Links diff --git a/mpc-core-kit-web/quick-starts/mpc-core-kit-react-quick-start/README.md b/mpc-core-kit-web/quick-starts/mpc-core-kit-react-quick-start/README.md index 3f3d13e6..15e38628 100644 --- a/mpc-core-kit-web/quick-starts/mpc-core-kit-react-quick-start/README.md +++ b/mpc-core-kit-web/quick-starts/mpc-core-kit-react-quick-start/README.md @@ -1,28 +1,28 @@ -# Web3Auth (`@web3auth/modal`) x EVM x React +# Web3Auth MPC CoreKit Web [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) QuickStart - React -[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/pnp/web/modal) +[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) [![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) [Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. -This example demonstrates how to use Web3Auth with EVM in React. +This example demonstrates how to use Web3Auth's MPC CoreKit Web SDK in a React environment. ## How to Use ### Download Manually ```bash -npx degit Web3Auth/web3auth-pnp-examples/web-modal-sdk/evm/react-evm-modal-example w3a-modal-evm-react +npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-web/quick-starts/mpc-core-kit-react-quick-start w3a-mpc-core-kit-react-quick-start ``` Install & Run: ```bash -cd w3a-modal-evm-react +cd w3a-mpc-core-kit-react-quick-start npm install npm run start # or -cd w3a-modal-evm-react +cd w3a-mpc-core-kit-react-quick-start yarn yarn start ``` diff --git a/mpc-core-kit-web/quick-starts/mpc-core-kit-vue-quick-start/README.md b/mpc-core-kit-web/quick-starts/mpc-core-kit-vue-quick-start/README.md index 6149325f..db9399cb 100644 --- a/mpc-core-kit-web/quick-starts/mpc-core-kit-vue-quick-start/README.md +++ b/mpc-core-kit-web/quick-starts/mpc-core-kit-vue-quick-start/README.md @@ -1,30 +1,30 @@ -# Web3Auth (`@web3auth/modal`) x EVM x Vue.js +# Web3Auth MPC CoreKit Web [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) QuickStart - Vue.js -[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/pnp/web/modal) +[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) [![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) [Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. -This example demonstrates how to use Web3Auth with EVM in Vue.js +This example demonstrates how to use Web3Auth's MPC CoreKit Web SDK in a Vue.js application. ## How to Use ### Download Manually ```bash -npx degit Web3Auth/web3auth-pnp-examples/web-modal-sdk/evm/vue-evm-modal-example w3a-modal-evm-vue +npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-web/quick-starts/mpc-core-kit-vue-quick-start w3a-mpc-core-kit-vue-quick-start ``` Install & Run: ```bash -cd w3a-modal-evm-vue +cd w3a-mpc-core-kit-vue-quick-start npm install -npm run serve +npm run start # or -cd w3a-modal-evm-vue +cd w3a-mpc-core-kit-vue-quick-start yarn -yarn serve +yarn start ``` ## Important Links