Skip to content

Commit 9bfd247

Browse files
authored
fix: update readme docs (#1354)
1 parent e88f671 commit 9bfd247

File tree

3 files changed

+44
-23
lines changed

3 files changed

+44
-23
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
11
# sdk-install-modal-web
2+
3+
Install modal web package for multichain, renders and uses the new mobile wallet protocol ConnectionRequest QRCodes.
4+
5+
This project includes fully functional InstallModal web used in the Multichain SDK for Trusted flows.
6+
7+
Untrusted flows use the OTPModal which exists but is not yet fully supported.
8+
9+
## Development
10+
11+
```bash
12+
yarn dev
13+
```
14+
15+
or
16+
17+
```bash
18+
yarn start
19+
```
20+
21+
## Building locally
22+
23+
```bash
24+
yarn build
25+
```

packages/sdk-multichain/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,23 @@ src/
2222
├── multichain/ # Concrete implementations
2323
└── store/ # Storage implementations
2424
```
25+
26+
27+
## Building Locally
28+
Either build with ```yarn build``` from the root workspace project or build directly the package, in this last case, it is required that u build [ui package first](../sdk-multichain-ui/README.md)
29+
30+
```bash
31+
yarn build
32+
```
33+
34+
## Running Tests
35+
36+
```bash
37+
yarn test
38+
```
39+
40+
with coverage
41+
42+
```bash
43+
yarn test:ci
44+
```

playground/multichain-react/README.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,6 @@ A test dapp for the MetaMask Multichain API.
66

77
`yarn`
88

9-
## Configuration
10-
11-
### Environment Variables
12-
13-
This project supports optional environment variables for enhanced functionality:
14-
15-
#### Helius RPC API Key (Optional)
16-
For improved Solana RPC performance, you can configure a Helius API key:
17-
18-
1. Copy the example environment file:
19-
```bash
20-
cp .env.example .env.local
21-
```
22-
23-
2. Get a free API key from [Helius](https://www.helius.dev/)
24-
25-
3. Add your API key to `.env.local`:
26-
```
27-
REACT_APP_HELIUS_API_KEY=your_actual_api_key_here
28-
```
29-
30-
**Note:** If no Helius API key is provided, the app will automatically fall back to public Solana RPC endpoints.
31-
329
## Usage
3310

3411
To start the development server:

0 commit comments

Comments
 (0)