Fix off-by-one in docs (#64)

charlesnicholson · Oct 1, 2024 · d72e03d · d72e03d
1 parent 350abc1
commit d72e03d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -5,4 +5,5 @@
 * [Michael Reed](https://github.com/mreed348)
 * [Oscar Reparaz](https://github.com/oreparaz)
 * [H. James Zhao](https://github.com/hantianjz)
+* [redfast00](https://github.com/redfast00)
 
diff --git a/README.md b/README.md
@@ -121,7 +121,7 @@ char buf[64];
 buf[0] = COBS_TINYFRAME_SENTINEL_VALUE; // You have to do this.
 buf[63] = COBS_TINYFRAME_SENTINEL_VALUE; // You have to do this.
 
-// Now, fill buf[1 .. 63] with whatever data you want.
+// Now, fill in buf[1] up to and including buf[62] (so 64 - 2 = 62 bytes of payload data)
 
 cobs_ret_t const result = cobs_encode_tinyframe(buf, 64);