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

Commit

Permalink
feat!: update libp2p interfaces (#15)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: uses new single-issue libp2p interface modules
  • Loading branch information
achingbrain committed Jun 15, 2022
1 parent 5099d52 commit 12b8be4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
23 changes: 13 additions & 10 deletions README.md
@@ -1,21 +1,24 @@
# js-libp2p-webrtc-peer <!-- omit in toc -->
# @libp2p/webrtc-peer <!-- omit in toc -->

[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-webrtc-peer/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-webrtc-peer?branch=master)
[![Build Status](https://github.com/libp2p/js-libp2p-webrtc-peer/actions/workflows/js-test-and-release.yml/badge.svg?branch=main)](https://github.com/libp2p/js-libp2p-webrtc-peer/actions/workflows/js-test-and-release.yml)
[![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-peer.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-peer)
[![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-peer/actions/workflows/js-test-and-release.yml)

> Simple one-to-one WebRTC data channels
## Table of Contents <!-- omit in toc -->
## Table of contents <!-- omit in toc -->

- [Install](#install)
- [Usage](#usage)
- [License](#license)
- [Contribution](#contribution)
- [Contribution](#contribution)

## Install

```sh
> npm i @libp2p/webrtc-peer
```console
$ npm i @libp2p/webrtc-peer
```

## Usage
Expand All @@ -33,9 +36,9 @@ channel.addEventListener('signal', (signal) => {

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)
- 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>)

### Contribution
## 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.
9 changes: 5 additions & 4 deletions package.json
Expand Up @@ -26,6 +26,7 @@
],
"exports": {
".": {
"types": "./src/index.d.ts",
"import": "./dist/src/index.js"
}
},
Expand Down Expand Up @@ -127,20 +128,20 @@
"release": "aegir release"
},
"dependencies": {
"@libp2p/interfaces": "^2.0.1",
"@libp2p/logger": "^1.1.2",
"@libp2p/interfaces": "^3.0.2",
"@libp2p/logger": "^2.0.0",
"delay": "^5.0.0",
"err-code": "^3.0.1",
"iso-random-stream": "^2.0.2",
"it-pushable": "^2.0.1",
"it-pushable": "^3.0.0",
"it-stream-types": "^1.0.4",
"p-defer": "^4.0.0",
"p-event": "^5.0.1",
"uint8arrays": "^3.0.0"
},
"devDependencies": {
"@mapbox/node-pre-gyp": "^1.0.8",
"aegir": "^37.0.15",
"aegir": "^37.2.0",
"it-first": "^1.0.7",
"it-pipe": "^2.0.3",
"wherearewe": "^1.0.2",
Expand Down

0 comments on commit 12b8be4

Please sign in to comment.