docs: adding circuit docs

ipfs · Jan 30, 2018 · e77b9a7 · e77b9a7
1 parent b08fb20
commit e77b9a7
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -198,7 +198,13 @@ const node = new IPFS({
   EXPERIMENTAL: { // enable experimental features
     pubsub: true,
     sharding: true, // enable dir sharding
-    dht: true // enable KadDHT, currently not interopable with go-ipfs
+    dht: true, // enable KadDHT, currently not interopable with go-ipfs
+    relay: {
+      enabled: true, // enable circuit relay dialer and listener
+      hop: {
+        enabled: true // enable circuit relay HOP (make this node a relay) 
+      }
+    }
   },
   config: { // overload the default IPFS node config, find defaults at https://github.com/ipfs/js-ipfs/tree/master/src/core/runtime
     Addresses: {