README.md

@libp2p/pubsub

libp2p pubsub base class

Table of contents

• Install
  • Browser <script> tag
• Usage
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/pubsub

Browser <script> tag

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

<script src="https://unpkg.com/@libp2p/pubsub/dist/index.min.js"></script>

Usage

npm i @libp2p/pubsub

import { PubSubBaseProtocol } from '@libp2p/pubsub'

class MyPubsubImplementation extends PubSubBaseProtocol {
  // .. extra methods here
}

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_pubsub.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

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.