/ for relative hostname

peers · Mar 6, 2013 · 730339e · 730339e
1 parent 8772dbb
commit 730339e
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/api.md b/docs/api.md
@@ -12,7 +12,7 @@ This class is a Peer, which can connect to other peers and listen for connection
 * `id` String. The id by which this peer will be identified when other peers try to connect to it. If no id is given, one will be generated by the server
 * `options` Object
   * `key` String. API key for cloud PeerServer. Is not used for servers other than `cloud.peerjs.com`
-  * `host` String. Server host. Default `cloud.peerjs.com`
+  * `host` String. Server host. Default `cloud.peerjs.com`. Also accepts `'/'` for relative hostname.
   * `port` Number. Server port. Default `80`
   * `config` Object. Configuration hash passed to `RTCPeerConnection`. This hash contains the ICE servers. Default `{ 'iceServers': [{ 'url': 'stun:stun.l.google.com:19302' }] }`
   * `debug` Boolean. Prints verbose log messages. Default `false`