tallyho-onboarding
Advanced tools
tallyho-onboarding - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
| { | ||
| "name": "tallyho-onboarding", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "description": "Assists with onboarding new Tally users", | ||
@@ -5,0 +5,0 @@ "main": "dist/tallyho-onboarding.cjs.js", |
@@ -1,32 +0,32 @@ | ||
| # MetaMask Onboarding | ||
| # Tally Ho 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 is used to help onboard new Tally Ho users. It allows you to ask the Tally Ho 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. | ||
| This library will register the current page as having initiated onboarding, so that Tally Ho knows where to redirect the user after onboarding. Note that the page will be automatically reloaded a single time once a Tally Ho installation is detected, in order to facilitate this registration. | ||
| > This package was originally used with [Metamask's](https://metamask.io) [onboarding package](https://docs.metamask.io/guide/onboarding-library.html) | ||
| ## Installation | ||
| `@metamask/onboarding` is made available as either a CommonJS module, and ES6 module, or an ES5 bundle. | ||
| `@tallyho-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) | ||
| - ES6 module: `import TallyHoOnboarding from '@tallyho-onboarding'` | ||
| - ES5 module: `const TallyHoOnboarding = require('@tallyho-onboarding')` | ||
| - ES5 bundle: `dist/tallyho-onboarding.bundle.js` (this can be included directly in a page) | ||
| ## Usage | ||
| [See _§ Onboarding Library_ on the MetaMask Docs website for examples.](https://docs.metamask.io/guide/onboarding-library.html) | ||
| ## API | ||
| Assuming `import MetaMaskOnboarding from '@metamask/onboarding'`, the following API is available. | ||
| Assuming `import TallyHoOnboarding from '@tallyho-onboarding'`, the following API is available. | ||
| ### Static methods | ||
| #### `MetaMaskOnboarding.isMetaMaskInstalled()` | ||
| #### `TallyHoOnboarding.isTallyHoInstalled()` | ||
| Returns `true` if a MetaMask-like provider is detected, or `false` otherwise. Note that we don't provide any guarantee that this is correct, as non-MetaMask wallets can disguise themselves as MetaMask. | ||
| Returns `true` if the Tally Ho provider is detected, or `false` otherwise. | ||
| ### Static properties | ||
| #### `MetaMaskOnboarding.FORWARDER_MODE` | ||
| #### `TallyHoOnboarding.FORWARDER_MODE` | ||
@@ -37,8 +37,8 @@ A set of constants for each of the available forwarder modes. | ||
| | :--------- | :------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `INJECT` | Inject a `iframe` to that will refresh until MetaMask has installed | | ||
| | `OPEN_TAB` | Open a tab to a new page that will refresh until MetaMask has installed—this is only useful if the client app has disallowed `iframes` | | ||
| | `INJECT` | Inject a `iframe` to that will refresh until Tally Ho has installed | | ||
| | `OPEN_TAB` | Open a tab to a new page that will refresh until Tally Ho has installed—this is only useful if the client app has disallowed `iframes` | | ||
| ### Constructor | ||
| #### `new MetaMaskOnboarding()` | ||
| #### `new TallyHoOnboarding()` | ||
@@ -50,3 +50,3 @@ The constructor accepts an optional options bag with the following: | ||
| | `forwarderOrigin` | Override the forwarder URL, useful for testing. **Optional**, defaults to `'https://fwd.metamask.io'`. | | ||
| | `forwarderMode` | One of the available forwarder modes. **Optional**, defaults to `MetaMaskOnboarding.FORWARDER_MODE.INJECT`. | | ||
| | `forwarderMode` | One of the available forwarder modes. **Optional**, defaults to `TallyHoOnboarding.FORWARDER_MODE.INJECT`. | | ||
@@ -57,3 +57,3 @@ ### Instance methods | ||
| Starts onboarding by opening the MetaMask download page and waiting for MetaMask to be installed. Once the MetaMask extension installation is detected, a message will be sent to MetaMask to register the current site as the onboarding initiator. | ||
| Starts onboarding by opening the MetaMask download page and waiting for Tally Ho to be installed. Once the Tally Ho extension installation is detected, a message will be sent to Tally Ho to register the current site as the onboarding initiator. | ||
@@ -80,3 +80,3 @@ #### `stopOnboarding()` | ||
| The project follows the same release process as the other libraries in the MetaMask organization: | ||
| The project follows the same release process as the other libraries in the Tally Ho organization: | ||
@@ -83,0 +83,0 @@ 1. Create a release branch |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.11%
109188
No dependency changes