Add README

This commit is contained in:
Stuckinaboot 2018-10-21 15:23:39 -04:00
parent 7d124bb047
commit 7709df9c10

3
peer/README.md Normal file
View File

@ -0,0 +1,3 @@
# PeerStore
The PeerStore contains a mapping of peer IDs to PeerData objects. Each PeerData object represents a peer, and each PeerData contains a collection of protocols, addresses, and a mapping of metadata. PeerStore implements both the IPeerStore (peer protocols), IAddrBook (address book), IPeerMetadata (peer metadata) interfaces, which allows the peer store to effectively function as a dictionary for peer ID to protocol, address, and metadata.