@libp2p/pubsub 9.0.10-fb7c51c3c → 9.0.11-1fc929c1c

package/README.md

@@ -1,3 +1,5 @@
+# @libp2p/pubsub
+
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -5,6 +7,51 @@
 
 > libp2p pubsub base class
 
+# About
+
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
+A set of components to be extended in order to create a pubsub implementation.
+
+## Example
+
+```TypeScript
+import { PubSubBaseProtocol } from '@libp2p/pubsub'
+import type { PubSubRPC, PublishResult, PubSubRPCMessage, PeerId, Message } from '@libp2p/interface'
+import type { Uint8ArrayList } from 'uint8arraylist'
+
+class MyPubsubImplementation extends PubSubBaseProtocol {
+  decodeRpc (bytes: Uint8Array | Uint8ArrayList): PubSubRPC {
+    throw new Error('Not implemented')
+  }
+
+  encodeRpc (rpc: PubSubRPC): Uint8Array {
+    throw new Error('Not implemented')
+  }
+
+  encodeMessage (rpc: PubSubRPCMessage): Uint8Array {
+    throw new Error('Not implemented')
+  }
+
+  async publishMessage (sender: PeerId, message: Message): Promise<PublishResult> {
+    throw new Error('Not implemented')
+  }
+}
+```
+
 # Install
 
 ```console