Michelle Bu 12 years ago
parent
commit
bcc47553f1
1 changed files with 5 additions and 1 deletions
  1. 5 1
      docs/api.md

+ 5 - 1
docs/api.md

@@ -47,7 +47,9 @@ Returns a `DataConnection` object.
 * `options` Object.
 * `options` Object.
   * `metadata` Optional metadata to pass to the remote peer. Can be any serializable type.
   * `metadata` Optional metadata to pass to the remote peer. Can be any serializable type.
   * `serialization` String, which can be `binary`, `binary-utf8`, `json`, or `none`. This will be the serialization format of all data sent over the P2P DataConnection. Defaults to `binary`.
   * `serialization` String, which can be `binary`, `binary-utf8`, `json`, or `none`. This will be the serialization format of all data sent over the P2P DataConnection. Defaults to `binary`.
-  * `reliable` Boolean, which if `true` activates experimental reliable transfer (while waiting for actual reliable transfer to be implemented in Chrome). Defaults to `false` until Chrome implements reliable/large data transfer.
+  * `reliable` Boolean, which if `true` activates experimental reliable transfer (while waiting for actual reliable transfer to be implemented in Chrome).
+    * Defaults to `false` until Chrome implements reliable/large data transfer.
+    * This parameter is only available in the most recent build, not on the stable version of PeerJS in the CDN.
 
 
 Before writing to / data will be emitted from the `DataConnection` object that is returned, the `open` event must fire. Also the `error` event should be checked in case a connection cannot be made.
 Before writing to / data will be emitted from the `DataConnection` object that is returned, the `open` event must fire. Also the `error` event should be checked in case a connection cannot be made.
 
 
@@ -106,6 +108,8 @@ There is no constructor. A `DataConnection` object must be obtained in the callb
 
 
 ### EXPERIMENTAL reliable and large file transfer:
 ### EXPERIMENTAL reliable and large file transfer:
 
 
+This feature is only available in the most recent build, not on the stable version of PeerJS in the CDN.
+
 Simply pass in `reliable: true` when calling `.connect(...)`. This module is experimental, temporary, and exists here: https://github.com/michellebu/reliable
 Simply pass in `reliable: true` when calling `.connect(...)`. This module is experimental, temporary, and exists here: https://github.com/michellebu/reliable
   
   
 ### connection.id
 ### connection.id