Permalink
Browse files

advisory

  • Loading branch information...
1 parent 34e704e commit f8ce0c175740938cd7829f8912c8e1dc4e112d75 @michelle michelle committed Apr 3, 2013
Showing with 1 addition and 1 deletion.
  1. +1 −1 docs/api.md
View
@@ -9,7 +9,7 @@ This class is a Peer, which can connect to other peers and listen for connection
### new Peer([id], [options])
-* `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
+* `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. **Note that this ID is mainly used for brokering and that it is not recommended that you use it to identify peers. Also note that you can set a `metadata` option to send other identifying information.**
* `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`. Also accepts `'/'` for relative hostname.

0 comments on commit f8ce0c1

Please sign in to comment.