Improve demo.

[string-lerp.git] / README.md

diff --git a/README.md b/README.md
index 8ec9670..6d89262 100644 (file)
--- a/README.md
+++ b/README.md
@@ -96,9 +96,19 @@ the strings are similar.
 ### stringLerp.diff(s, t) and stringLerp.patch(edits, s)
 
 These are the functions used to implement `diffLerp`. `diff`
-calculates a series of edit operations - substitutions, insertions,
+calculates an array of edit operations - substitutions, insertions,
 and deletions - to turn `s` into `t`.
 
+The type of the edit operations is unspecified. What is guaranteed is:
+
+* There's an Array of them.
+* The array can be cut up and applied in-order but piecemeal.
+* They are simple objects, i.e. can be (de)serialized via JSON and fed
+  into the same version of `patch` later.
+  
+Do not rely on edit operations to be exactly the same type (or same
+operations) between versions / installations.
+
 
 ### stringLerp.levenshteinMatrix(s, t, ins, del, sub)