Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

docs

  • Loading branch information...
commit 8772dbb456924be45df9c0e63ac409ffbf7257a4 1 parent 7705e7a
Michelle Bu michelle authored
Showing with 9 additions and 3 deletions.
  1. +2 −0  README.md
  2. +6 −0 changelog.md
  3. +1 −3 docs/api.md
2  README.md
View
@@ -46,6 +46,8 @@ Each peer simply provides a identifier with which other peers using the same API
### [Discuss PeerJS on our Google Group](https://groups.google.com/forum/?fromgroups#!forum/peerjs)
+### [Changelog](https://github.com/peers/peerjs/blob/master/changelog.md)
+
## In the future
6 changelog.md
View
@@ -0,0 +1,6 @@
+# PeerJS Changelog
+
+## Version 0.1.7
+* Add experimental `reliable` messaging option. [See documentation.](https://github.com/peers/peerjs/blob/master/docs/api.md#experimental-reliable-and-large-file-transfer)
+* Fix bug where the ID /GET request was cached and so two Peers created simultaneously would get the same ID: [See issue.](https://github.com/peers/peerjs-server/issues/2)
+* Add support for relative hostname. [See documentation.](https://github.com/peers/peerjs/blob/master/docs/api.md#new-peerid-options)
4 docs/api.md
View
@@ -47,7 +47,7 @@ Returns a `DataConnection` object.
* `options` Object.
* `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`.
- * `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.
+ * `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.
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,8 +106,6 @@ There is no constructor. A `DataConnection` object must be obtained in the callb
### 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
### connection.id
Please sign in to comment.
Something went wrong with that request. Please try again.