braid-text 0.2.58 → 0.2.60

package/README.md

@@ -119,7 +119,7 @@ Here's a basic running example to start:
 </script>
 ```
 
-You should see something if you run this (though the server in this example will likely ignore your changes). 
+You should see some text in a box if you run this, and if you run it in another tab, you should be able to edit that text collaboratively.
 
 ### How It Works
 
@@ -135,6 +135,14 @@ This design prevents network congestion and handles disconnections gracefully. F
 
 For better performance and control, you can work with patches instead of full text:
 
+#### Patch Format
+
+Each patch is an object with two properties:
+- `range`: `[start, end]` - The range of characters to delete
+- `content`: The text to insert at that position
+
+Patches in an array each have positions which refer to the **original text** before any other patches are applied.
+
 #### Receiving Patches
 
 Instead of receiving complete text updates, you can process individual changes:
@@ -213,6 +221,8 @@ Creates a new Simpleton client that synchronizes with a Braid-Text server.
   ```
   If not provided, uses a simple prefix/suffix diff algorithm.
 
+  **Note:** All patches must reference positions in the original text before any patches are applied.
+
 #### Additional Options
 
 - `content_type`: <small style="color:lightgrey">[optional]</small> MIME type for `Accept` and `Content-Type` headers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-text",
-  "version": "0.2.58",
+  "version": "0.2.60",
   "description": "Library for collaborative text over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-text",