feat(dht): add dht.findprovs spec

ipfs-inactive · Aug 9, 2016 · 818e2d1 · 818e2d1
1 parent 0deb6ad
commit 818e2d1
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/API/dht/README.md b/API/dht/README.md
@@ -32,11 +32,19 @@ ipfs.dht.findPeer(id, function (err, peerInfo) {
 
 ##### `JavaScript` - ipfs.dht.findprovs(hash, [callback])
 
+Where `hash` is a multihash.
+
+`callback` must follow `function (err, peerInfos) {}` signature, where `err` is an error if the operation was not successful. `peerInfos` is an array of objects of type [PeerInfo](https://github.com/libp2p/js-peer-info)
+
 If no `callback` is passed, a promise is returned.
 
 Example:
 
-
+```JavaScript
+ipfs.dht.findProvs(hash, function (err, peerInfos) {
+  // peerInfo will contain the multiaddrs of that peer
+})
+```
 
 #### `get`