Skip to content
Merged
Changes from all commits
Commits
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
80 changes: 13 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,18 @@

[![codecov](https://codecov.io/gh/MetaMask/metamask-sdk/graph/badge.svg?token=6B3Z3724OO)](https://codecov.io/gh/MetaMask/metamask-sdk)

MetaMask SDK enables developers to easily connect their dapps with the MetaMask browser extension
and MetaMask Mobile.

It supports the following dapp platforms:

- [Javascript-based apps](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/)
- [React](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/react/)
- [Pure JavaScript](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/pure-js/)
- [Other web frameworks](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/other-web-frameworks/)
- [React Native](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/react-native/)
- [Node.js](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/nodejs/)
- [Electron](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/electron/)
- [Gaming apps](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/gaming/)
- [Unity](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/gaming/unity/)
- [Unreal Engine](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/gaming/unreal-engine/) (coming soon)
- [Mobile Native apps](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/mobile/)
- [iOS](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/mobile/ios/)
- [Android](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/mobile/android/)

Read more about [setting up MetaMask SDK](https://docs.metamask.io/sdk) and
[MetaMask SDK concepts](https://docs.metamask.io/wallet/concepts/sdk/).

This repository contains the JavaScript SDK and examples.
You can also see the [Android SDK repository](https://github.com/MetaMask/metamask-android-sdk/tree/main)
and the [iOS SDK repository](https://github.com/MetaMask/metamask-ios-sdk/tree/main).
MetaMask SDK enables developers to seamlessly connect their dapps to the MetaMask extension and mobile app.

You can use the SDK via the following platforms and libraries:

- [Wagmi](https://docs.metamask.io/sdk/connect/javascript-wagmi/) (recommended)
- [JavaScript](https://docs.metamask.io/sdk/connect/javascript/)
- [Dynamic SDK](https://docs.metamask.io/sdk/connect/javascript-dynamic/)
- [Web3Auth SDK](https://docs.metamask.io/sdk/connect/javascript-web3auth/)
- [React Native](https://docs.metamask.io/sdk/connect/react-native/)
- [Web3-Onboard](https://onboard.blocknative.com/)

See the [MetaMask SDK documentation](https://docs.metamask.io/sdk/) for more information.

## Features

Expand All @@ -53,50 +40,9 @@ or
npm i @metamask/sdk
```

### Web dapps

![](./docs/demo_web.gif)

See the following examples:

- [Next.js](./packages/examples/nextjs-demo/README.md)
- [React](./packages/examples/create-react-app/README.md)
- [Vue.js](./packages/examples/vuejs/README.md)
- [Pure JavaScript](./packages/examples/pure-javascript/README.md)

Read the documentation for
[using the SDK with JavaScript](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/)
for more information.

### React Native

![](./docs/demo_rn_ios.gif)

We recommend using React Native v0.71.4 or higher to avoid performance issues on Android.

See the [React Native example](./packages/examples/reactNativeDemo/README.md) and read the
documentation for [using the SDK with React Native](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/react-native/)
for more information.

### Node.js

![](./docs/demo_nodejs.gif)

See the [Node.js example](./packages/examples/nodejs/README.md) and read the documentation for
[using the SDK with Node.js](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/nodejs/)
for more information.

### Electron

![](./docs/demo_electron.gif)

See the [Electron example](./packages/examples/electronjs/README.md) and read the documentation for
[using the SDK with Electron](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/javascript/electron/)
for more information.

## SDK options

See the full list of [JavaScript SDK options](https://docs.metamask.io/wallet/reference/sdk-js-options/).
See the full list of [JavaScript SDK options](https://docs.metamask.io/sdk/reference/sdk-options/).

## Contributing

Expand Down
Loading