JSPM

  • Created
  • Published
  • Downloads 2521
  • Score
    100M100P100Q94114F
  • License MIT

JavaScript implementation of the IPFS Mutable File System

Package Exports

  • ipfs-mfs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ipfs-mfs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ipfs-mfs JavaScript Implementation

standard-readme compliant Build Status Coverage Status Dependency Status js-standard-style

JavaScript implementation of the IPFS Mutable File System

The MFS spec can be found inside the ipfs/specs repository

Table of Contents

Install

npm

> npm i ipfs-mfs

Use in Node.js

const mfs = require('ipfs-mfs')

Use in a browser with browserify, webpack or any other bundler

The code published to npm that gets loaded on require is an ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.

const mfs = require('ipfs-mfs')

Use in a browser using a script tag

Loading this module through a script tag will make the mfs obj available in the global namespace.

<script src="https://npmcdn.com/ipfs-mfs/dist/index.min.js"></script>
<!-- OR -->
<script src="https://npmcdn.com/ipfs-mfs/dist/index.js"></script>

Contribute

All are welcome, please join in! Open an issue or send a PR!

This repository falls under the IPFS Code of Conduct.

License

MIT