Skip to content
This repository has been archived by the owner on Apr 24, 2023. It is now read-only.

Commit

Permalink
fix!: update multiformats to v11 (#202)
Browse files Browse the repository at this point in the history
The CID class has breaking changes in multiformats v11 so update all
deps to the new version
  • Loading branch information
achingbrain authored Jan 6, 2023
1 parent 2d9fb2e commit 4f69ed4
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/automerge.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.

name: Automerge
on: [ pull_request ]

Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/js-test-and-release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.

name: test & maybe release
on:
push:
Expand All @@ -27,7 +24,7 @@ jobs:
strategy:
matrix:
os: [windows-latest, ubuntu-latest, macos-latest]
node: [16]
node: [lts/*]
fail-fast: true
steps:
- uses: actions/checkout@v3
Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,38 @@ https://github.com/libp2p/js-libp2p/issues/1462
# @libp2p/webrtc-direct <!-- omit in toc -->

[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-webrtc-direct.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-direct)
[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-webrtc-direct/actions/workflows/js-test-and-release.yml)
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-webrtc-direct/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-webrtc-direct/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)

> Dial using WebRTC without the need to set up any Signalling Rendezvous Point!
## Table of contents <!-- omit in toc -->

- [Install](#install)
- [Browser `<script>` tag](#browser-script-tag)
- [Usage](#usage)
- [API](#api)
- [Transport](#transport)
- [Connection](#connection)
- [Contribute](#contribute)
- [License](#license)
- [Contribute](#contribute-1)
- [Contribution](#contribution)

## Install

```console
$ npm i @libp2p/webrtc-direct
```

### Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `Libp2pWebrtcDirect` in the global namespace.

```html
<script src="https://unpkg.com/@libp2p/webrtc-direct/dist/index.min.js"></script>
```

![](https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/connection/img/badge.png)
![](https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/transport/img/badge.png)

Expand Down Expand Up @@ -91,6 +99,6 @@ Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

## Contribute
## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -148,18 +148,18 @@
"@multiformats/multiaddr": "^11.0.0",
"abortable-iterator": "^4.0.2",
"err-code": "^3.0.0",
"multiformats": "^10.0.0",
"multiformats": "^11.0.0",
"native-fetch": "^4.0.2",
"p-event": "^5.0.1",
"uint8arrays": "^4.0.2",
"undici": "^5.2.0",
"wherearewe": "^2.0.1"
},
"devDependencies": {
"@libp2p/interface-mocks": "^7.0.1",
"@libp2p/interface-mocks": "^9.0.0",
"@libp2p/interface-transport-compliance-tests": "^3.0.0",
"@mapbox/node-pre-gyp": "^1.0.8",
"aegir": "^37.5.3",
"aegir": "^37.9.1",
"it-all": "^2.0.0",
"it-pipe": "^2.0.3",
"it-stream-types": "^1.0.4",
Expand Down

0 comments on commit 4f69ed4

Please sign in to comment.