Permalink
Browse files

Bump version and update readme with details for breaking change.

  • Loading branch information...
1 parent 770c9e6 commit 03fad7573eb6927e72e26f2d14bca4542726ab9f @maryrosecook maryrosecook committed Mar 20, 2012
Showing with 16 additions and 4 deletions.
  1. +14 −2 README.md
  2. +2 −2 src/backpusher.js
View
@@ -1,6 +1,18 @@
-## Backpusher
+## Backpusher 0.0.2
-For details, please read the [article on our blog](http://blog.pusher.com/2011/6/21/backbone-js-now-realtime-with-pusher) about this library.
+## What is this?
+
+Backpusher is a library for using Pusher to sync your Backbone models between clients, the server and other clients. For details, please read the [article on our blog](http://blog.pusher.com/2011/6/21/backbone-js-now-realtime-with-pusher).
+
+## Breaking change in version 0.0.2
+
+### The change
+
+When Backpusher syncs data via `Backbone.sync()`, it sends the `socket_id` of the client connection that initiated the sync. In version 0.0.1, this data was sent as a URL parameter. In version 0.0.2, this data is sent as a header.
+
+### Updating your code
+
+Find any pieces of code that use the `socket_id` sent by a `Backbone.sync()` request. Update these pieces of code to retrieve the `socket_id` from the headers of the request, rather than the URL.
## Requirements
View
@@ -1,5 +1,5 @@
-// Backpusher.js 0.0.1
-// (c) 2011 Pusher.
+// Backpusher.js 0.0.2
+// (c) 2011-2012 Pusher.
// Backpusher may be freely distributed under the MIT license.
// For all details and documentation:
// http://github.com/pusher/backpusher

0 comments on commit 03fad75

Please sign in to comment.