|
2 | 2 |
|
3 | 3 | [](https://codecov.io/gh/MetaMask/metamask-sdk) |
4 | 4 |
|
5 | | -MetaMask SDK enables developers to easily connect their dapps with the MetaMask browser extension |
6 | | -and MetaMask Mobile. |
7 | | - |
8 | | -It supports the following dapp platforms: |
9 | | - |
10 | | -- [Javascript-based apps](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/) |
11 | | - - [React](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/react/) |
12 | | - - [Pure JavaScript](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/pure-js/) |
13 | | - - [Other web frameworks](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/other-web-frameworks/) |
14 | | - - [React Native](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/react-native/) |
15 | | - - [Node.js](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/nodejs/) |
16 | | - - [Electron](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/electron/) |
17 | | -- [Gaming apps](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/gaming/) |
18 | | - - [Unity](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/gaming/unity/) |
19 | | - - [Unreal Engine](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/gaming/unreal-engine/) (coming soon) |
20 | | -- [Mobile Native apps](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/mobile/) |
21 | | - - [iOS](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/mobile/ios/) |
22 | | - - [Android](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/mobile/android/) |
23 | | - |
24 | | -Read more about [setting up MetaMask SDK](https://docs.metamask.io/sdk) and |
25 | | -[MetaMask SDK concepts](https://docs.metamask.io/wallet/concepts/sdk/). |
26 | | - |
27 | | -This repository contains the JavaScript SDK and examples. |
28 | | -You can also see the [Android SDK repository](https://github.com/MetaMask/metamask-android-sdk/tree/main) |
29 | | -and the [iOS SDK repository](https://github.com/MetaMask/metamask-ios-sdk/tree/main). |
| 5 | +MetaMask SDK enables developers to seamlessly connect their dapps to the MetaMask extension and mobile app. |
| 6 | + |
| 7 | +You can use the SDK via the following platforms and libraries: |
| 8 | + |
| 9 | +- [Wagmi](https://docs.metamask.io/sdk/connect/javascript-wagmi/) (recommended) |
| 10 | +- [JavaScript](https://docs.metamask.io/sdk/connect/javascript/) |
| 11 | +- [Dynamic SDK](https://docs.metamask.io/sdk/connect/javascript-dynamic/) |
| 12 | +- [Web3Auth SDK](https://docs.metamask.io/sdk/connect/javascript-web3auth/) |
| 13 | +- [React Native](https://docs.metamask.io/sdk/connect/react-native/) |
| 14 | +- [Web3-Onboard](https://onboard.blocknative.com/) |
| 15 | + |
| 16 | +See the [MetaMask SDK documentation](https://docs.metamask.io/sdk/) for more information. |
30 | 17 |
|
31 | 18 | ## Features |
32 | 19 |
|
|
53 | 40 | npm i @metamask/sdk |
54 | 41 | ``` |
55 | 42 |
|
56 | | -### Web dapps |
57 | | - |
58 | | - |
59 | | - |
60 | | -See the following examples: |
61 | | - |
62 | | -- [Next.js](./packages/examples/nextjs-demo/README.md) |
63 | | -- [React](./packages/examples/create-react-app/README.md) |
64 | | -- [Vue.js](./packages/examples/vuejs/README.md) |
65 | | -- [Pure JavaScript](./packages/examples/pure-javascript/README.md) |
66 | | - |
67 | | -Read the documentation for |
68 | | -[using the SDK with JavaScript](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/) |
69 | | -for more information. |
70 | | - |
71 | | -### React Native |
72 | | - |
73 | | - |
74 | | - |
75 | | -We recommend using React Native v0.71.4 or higher to avoid performance issues on Android. |
76 | | - |
77 | | -See the [React Native example](./packages/examples/reactNativeDemo/README.md) and read the |
78 | | -documentation for [using the SDK with React Native](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/react-native/) |
79 | | -for more information. |
80 | | - |
81 | | -### Node.js |
82 | | - |
83 | | - |
84 | | - |
85 | | -See the [Node.js example](./packages/examples/nodejs/README.md) and read the documentation for |
86 | | -[using the SDK with Node.js](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/nodejs/) |
87 | | -for more information. |
88 | | - |
89 | | -### Electron |
90 | | - |
91 | | - |
92 | | - |
93 | | -See the [Electron example](./packages/examples/electronjs/README.md) and read the documentation for |
94 | | -[using the SDK with Electron](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/electron/) |
95 | | -for more information. |
96 | | - |
97 | 43 | ## SDK options |
98 | 44 |
|
99 | | -See the full list of [JavaScript SDK options](https://docs.metamask.io/wallet/reference/sdk-js-options/). |
| 45 | +See the full list of [JavaScript SDK options](https://docs.metamask.io/sdk/reference/sdk-options/). |
100 | 46 |
|
101 | 47 | ## Contributing |
102 | 48 |
|
|
0 commit comments