From e7a6a91ade38c78f8e6c53a66fc2ae23bd527334 Mon Sep 17 00:00:00 2001
From: Vasco Santos <vasco.santos@moxy.studio>
Date: Thu, 16 Jul 2020 14:47:58 +0200
Subject: [PATCH] feat: signed peer records for discovery

---
 src/peer-discovery/README.md | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/peer-discovery/README.md b/src/peer-discovery/README.md
index f66b0ba..d844925 100644
--- a/src/peer-discovery/README.md
+++ b/src/peer-discovery/README.md
@@ -72,7 +72,10 @@ It returns a `Promise`
 
 - `discovery.on('peer', (peerData) => {})`
 
-Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which must contain the following properties:
+Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which may contain the following properties:
 
-- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
-- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs`
+- [`<PeerId>`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
+- `<Array`[`<Multiaddr>`](https://github.com/multiformats/js-multiaddr)`>` `peerData.multiaddrs`
+- [`<Envelope>`](https://github.com/libp2p/js-libp2p/tree/0.29.x/src/record) `peerData.envelope`
+
+The `id` property is required, ad well as one of `multiaddrs` and `envelope`.