Skip to content

Update README.md #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
S0nee wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/screens/onboarding/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,35 @@ The onboarding feature guides the user through setting up their wallet in the ap

### Welcome Screen

- **Path**: `createWalletFlow/Welcome.tsx`
- **Path**: [`common/Welcome.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/common/Welcome.tsx)
- **Description**: The entry point of the onboarding process. The user is greeted and given the choice to either create a new wallet or import an existing one.

### Create Wallet Flow

- **Back Up Your Wallet**
- **Path**: `createWalletFlow/BackUpWallet.tsx`
- **Path**: [`create-wallet-flow/BackUpSeedPhrase.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/create-wallet-flow/BackUpSeedPhrase.tsx)
- **Description**: Guides the user through backing up their new wallet by noting down the seed phrase.
- **Verify Seed Phrase**
- **Path**: `createWalletFlow/VerifySeedPhrase.tsx`
- **Path**: [`create-wallet-flow/VerifySeedPhrase.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/create-wallet-flow/VerifySeedPhrase.tsx)
- **Description**: Ensures the user correctly noted the seed phrase by asking them to input it.
- **Create Password**
- **Path**: `common/CreatePassword.tsx`
- **Path**: [`common/CreatePassword.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/common/CreatePassword.tsx)
- **Description**: Allows the user to set a password for their wallet, adding an extra layer of security.
- **Select Transaction Type**
- **Path**: `createWalletFlow/SelectTransactionType.tsx`
- **Path**: [`create-wallet-flow/SelectTransactionType.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/create-wallet-flow/SelectTransactionType.tsx)
- **Description**: Lets the user choose the transaction type they prefer.
- **Confirmation**
- **Path**: `common/Confirmation.tsx`
- **Path**: [`common/Confirmation.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/common/Confirmation.tsx)
- **Description**: A final confirmation screen summarizing the wallet setup.

### Import Wallet Flow

- **Import Wallet (Seed Phrase)**
- **Path**: `importWalletFlow/ImportSeedPhrase.tsx`
- **Path**: [`import-wallet-flow/ImportSeedPhrase.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/import-wallet-flow/ImportSeedPhrase.tsx)
- **Description**: Allows the user to input their existing seed phrase to import their wallet.
- **Create Password**
- **Path**: `common/CreatePassword.tsx`
- **Path**: [`common/CreatePassword.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/common/CreatePassword.tsx)
- **Description**: Similar to the create wallet flow, this step involves creating a password for the imported wallet.
- **Confirmation**
- **Path**: `common/Confirmation.tsx`
- **Path**: [`common/Confirmation.tsx`](https://github.com/S0nee/miden-wallet/blob/README/src/screens/onboarding/common/Confirmation.tsx)
- **Description**: Confirms that the wallet has been successfully imported.