docs: add validate function to readme

libp2p · Jul 8, 2019 · 919e918 · 919e918
1 parent c36fefa
commit 919e918
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -68,6 +68,19 @@ class PubsubImplementation extends Pubsub {
 }
 ```
 
+### Validate
+
+Validates the signature of a message.
+
+#### `pubsub.validate(message, callback)`
+
+##### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| message | `Message` | a pubsub message |
+| callback | `function(Error, Boolean)` | calls back with true if the message is valid |
+
 ## Implementations using this base protocol
 
 You can use the following implementations as examples for building your own pubsub implementation.