diff --git a/README.md b/README.md index 3924ad4..0cace3a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ > Get `window.ipfs` with fallback to CDN if unavailable -The [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) web extension provides a `window.ipfs` object to web pages you visit. +The [IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion) web extension provides a [`window.ipfs` object](https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/window.ipfs.md) to web pages you visit. This module will detects the presence of `window.ipfs` and automatically falls back to downloading the latest version of IPFS from `https://unpkg.com/ipfs/dist/index.min.js` if it's unavailable. Note: can be configured to fallback to IPFS API. @@ -22,12 +22,14 @@ console.log(await ipfs.id()) ### `getIpfs([options])` -If `window.ipfs` is available, the promise is resolved with that node. +If `window.ipfs` is available, the promise is resolved with that node and default or customized capabilities. + +* `options.permissions` - (Object) Options to pass to override default behavior of `window.ipfs` If `window.ipfs` is unavailable, a `