From bdd2502ef6ea26acc26813ed7f362e1c272a7701 Mon Sep 17 00:00:00 2001 From: Vasco Santos Date: Mon, 6 Apr 2020 14:43:16 +0200 Subject: [PATCH] feat: peer-discovery not using peer-info BREAKING CHANGE: peer-discovery emits object with id and multiaddrs properties --- src/peer-discovery/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/peer-discovery/README.md b/src/peer-discovery/README.md index cd27ac4..a0551d0 100644 --- a/src/peer-discovery/README.md +++ b/src/peer-discovery/README.md @@ -72,4 +72,7 @@ It returns a `Promise` - `discovery.on('peer', (peerInfo) => {})` -Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discover peer's [PeerInfo](https://github.com/libp2p/js-peer-info). +Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discovered peer's information, which must contain the following properties: + +- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerInfo.id` +- `>` `peerInfo.multiaddrs`