Skip to content
This repository has been archived by the owner on Nov 4, 2020. It is now read-only.

Latest commit

 

History

History
39 lines (22 loc) · 1.16 KB

README.md

File metadata and controls

39 lines (22 loc) · 1.16 KB

Deprecated

This library has been deprecated and replaced with more flexible ipfs-provider.

This library will not be maintained.


window.ipfs-is-required

NPM JavaScript Style Guide

Prompt user to install IPFS Companion if window.ipfs is not available.

The IPFS Companion web extension provides a window.ipfs object to web pages you visit. This module will detects the presence of window.ipfs and if it isn't present, the user will be asked to install the web extension.

Usage

You can just add a script tag to your HTML file:

<script src='https://unpkg.com/window.ipfs-is-required/index.js' />

Or:

import ipfsIsRequired from 'window.ipfs-is-required'

ipfsIsRequired()

License

MIT © Henrique Dias