chore: peer discovery should emit peer id

BREAKING CHANGE: peer discovery event param is a PeerId instance instead of a PeerInfo instance
libp2p · Jan 7, 2020 · 0b505b3 · 0b505b3
1 parent 32ee3e1
commit 0b505b3
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/peer-discovery/README.md b/src/peer-discovery/README.md
@@ -69,6 +69,6 @@ It returns a `Promise`
 
 ### discoverying peers
 
-- `discovery.on('peer', (peerInfo) => {})`
+- `discovery.on('peer', (peerId) => {})`
 
-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 discover peer's [PeerId](https://github.com/libp2p/js-peer-id).