Skip to content

Commit

Permalink
chore: make ipfs-http-client a peer dependency (#32)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: The ipfs-http-client must now be installed
as a peer dependency. It is no longer included as a dependency
of this module.

The reason the http-client should be a peerDependency and
not a dependency is that its API requires knowledge of the
http-client (we pass in the api endpoint details).
  • Loading branch information
jacobheun authored Apr 23, 2020
1 parent f49ddc0 commit a1b1b5e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ Requires access to `/api/v0/dht/findpeer` HTTP API endpoint of the delegate node

[Jacob Heun](https://github.com/jacobheun)

## Requirements

`libp2p-delegated-peer-routing` leverages the `ipfs-http-client` library and requires it as a peer dependency, as such, both must be installed in order for this module to work properly.

```sh
npm install ipfs-http-client libp2p-delegated-peer-routing
```

## Example

```js
Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,14 @@
"dirty-chai": "^2.0.1",
"go-ipfs-dep": "0.4.23-3",
"ipfs-utils": "^2.2.0",
"ipfs-http-client": "^44.0.0",
"ipfsd-ctl": "^4.0.1"
},
"peerDependencies": {
"ipfs-http-client": "^44.0.0"
},
"dependencies": {
"debug": "^4.1.1",
"ipfs-http-client": "^44.0.0",
"p-queue": "^6.3.0",
"peer-id": "^0.13.11"
},
Expand Down

0 comments on commit a1b1b5e

Please sign in to comment.