From 7709df9c109334efd088f551cbe3c47de6394f15 Mon Sep 17 00:00:00 2001
From: Stuckinaboot <aspyn@seas.upenn.edu>
Date: Sun, 21 Oct 2018 15:23:39 -0400
Subject: [PATCH] Add README

---
 peer/README.md | 3 +++
 1 file changed, 3 insertions(+)
 create mode 100644 peer/README.md

diff --git a/peer/README.md b/peer/README.md
new file mode 100644
index 00000000..7de18dcc
--- /dev/null
+++ b/peer/README.md
@@ -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.