doc(config): expand peering docs

ipfs · Jun 12, 2020 · ea55e74 · ea55e74
1 parent b74246a
commit ea55e74
Showing 1 changed file with 17 additions and 4 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -745,15 +745,28 @@ Peering can be asymmetric or symmetric:
 
 #### `Peering.Peers`
 
-The set of peers with which to peer. Each entry is of the form:
+The set of peers with which to peer.
 
-```js
+```json
 {
-  "ID": "QmSomePeerID", # The peers ID.
-  "Addrs": ["/ip4/1.2.3.4/tcp/1234"] # Known addresses for the peer. If none are specified, the DHT will be queried.
+  "Peering": {
+    "Peers": [
+      {
+        "ID": "QmPeerID1",
+        "Addrs": ["/ip4/18.1.1.1/tcp/4001"]
+      },
+      {
+        "ID": "QmPeerID2",
+        "Addrs": ["/ip4/18.1.1.2/tcp/4001", "/ip4/18.1.1.2/udp/4001/quic"]
+      }
+    ]
+  }
+  ...
 }
 ```
 
+Where `ID` is the peer ID and `Addrs` is a set of known addresses for the peer. If no addresses are specified, the DHT will be queried.
+
 Additional fields may be added in the future.
 
 ## `Reprovider`