# metamask-onboarding
> Tools to support MetaMask one-click onboarding
Latest version **0.1.1** (published 2019-10-25) · 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install metamask-onboarding
pnpm add metamask-onboarding
yarn add metamask-onboarding
bun add metamask-onboarding
```
## Health
**Score 10/100 (F)** — status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 0.1.1 |
| Published | 2019-10-25 |
| First published | 2019-09-06 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 71.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 150 |
| Maintainers | gudahtt |
## Links
- npm: https://www.npmjs.com/package/metamask-onboarding
- Repository: https://github.com/MetaMask/metamask-onboarding
- Homepage: https://github.com/MetaMask/metamask-onboarding#readme
- Issues: https://github.com/MetaMask/metamask-onboarding/issues
- npm.io page: https://npm.io/package/metamask-onboarding
## Dependencies (1)
- [bowser](https://npm.io/package/bowser.md) ^2.5.4
## Recent versions
- 0.1.1 (latest) — 2019-10-25
- 0.1.0 — 2019-10-16
- 1.0.0 — 2019-09-06
## README
# MetaMask Onboarding
This library is used to help onboard new MetaMask users. It allows you to ask the MetaMask extension to redirect users back to your page after onboarding has finished.
This library will register the current page as having initiated onboarding, so that MetaMask knows where to redirect the user after onboarding. Note that the page will be automatically reloaded a single time once a MetaMask installation is detected, in order to facilitate this registration.
## Installation
`metamask-onboarding` is made available as either a CommonJS module, and ES6 module, or an ES5 bundle.
* ES6 module: `import MetamaskOnboarding from 'metamask-onboarding'`
* ES5 module: `const MetamaskOnboarding = require('metamask-onboarding')`
* ES5 bundle: `dist/metamask-onboarding.bundle.js` (this can be included directly in a page)
## Usage
Minimal example:
```
const onboarding = new MetamaskOnboarding()
onboarding.startOnboarding()
```
Here is an example of an onboarding button that uses this library:
```
Sample Dapp
```
---
_Source: https://npm.io/package/metamask-onboarding · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._