Skip to content
This repository has been archived by the owner on Dec 6, 2022. It is now read-only.

Commit

Permalink
docs: clarify README a bit
Browse files Browse the repository at this point in the history
Note that this module should be used through the IPLD resolver.
  • Loading branch information
vmx committed Jan 18, 2018
1 parent 9ad03c4 commit c3e17ba
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -12,7 +12,7 @@
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)

> JavaScript implementation of the [IPLD spec](https://github.com/ipfs/specs/tree/master/ipld).
> JavaScript implementation of the [IPLD format spec](https://github.com/ipld/interface-ipld-format) for Bitcoin blocks.
## Table of Contents

Expand Down Expand Up @@ -60,6 +60,10 @@ Loading this module through a script tag will make the `IpldBitcoint` obj availa

## Usage

As this is is an implementation of the [IPLD format spec](https://github.com/ipld/interface-ipld-format), it should be used through the [IPLD resolver](https://github.com/ipld/js-ipld-resolver). See the IPLD format spec for details about the API.

Though it can also be used as a standalone module:

```JavaScript
const IpldBitcoin = require('ipld-bitcoin')

Expand Down

0 comments on commit c3e17ba

Please sign in to comment.