From 5adb3e924cf1596675514038c40bbe1a9d12206d Mon Sep 17 00:00:00 2001
From: Jeff Schiller <codedread@gmail.com>
Date: Thu, 20 Jun 2024 12:34:32 -0700
Subject: [PATCH] Make BitStream docs a little clearer in README

---
 README.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7d63a23..e4bb0b8 100644
--- a/README.md
+++ b/README.md
@@ -169,9 +169,9 @@ BitStream, ByteStream.
 
 ```javascript
 import { BitStream } from './bitjs/io/bitstream.js';
-const bstream = new BitStream(someArrayBuffer, true, offset, length);
-const crc = bstream.readBits(12); // read in 12 bits as CRC, advancing the pointer
-const flagbits = bstream.peekBits(6); // look ahead at next 6 bits, but do not advance the pointer
+const bstream = new BitStream(someArrayBuffer, true /** most-significant-bit-to-least */ );
+const crc = bstream.readBits(12); // Read in 12 bits as CRC. Advance pointer.
+const flagbits = bstream.peekBits(6); // Look ahead at next 6 bits. Do not advance pointer.
 ```
 
 More details and examples are located on [the API page](./docs/bitjs.io.md).