fix: Documentation

Author: Mqxx

README.md

@@ -1,2 +1,24 @@
 # Binary Reader
 A binary reader package to read binary data.
+
+## Add Package
+```
+deno add jsr:@typescriptplayground/binary-reader
+```
+
+## Usage
+```ts
+import {BinaryReader} from "@typescriptplayground/binary-reader";
+
+const dataToRead = new Uint8Array([1,2,3,4])
+
+const reader = new BinaryReader(dataToRead.buffer);
+
+console.log(reader.read(2)) // ArrayBuffer { [Uint8Contents]: <01 02>, byteLength: 2 }
+
+console.log(reader.bufferLeft.byteLength) // 2
+
+console.log(reader.readInt16()) // 772
+
+console.log(reader.bufferLeft.byteLength) // 0
+```

deno.jsonc

@@ -1,6 +1,6 @@
 {
   "name": "@typescriptplayground/binary-reader",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "license": "./LICENSE",
   "exports": "./src/index.ts",
   "tasks": {

src/binary_reader.ts

@@ -3,6 +3,16 @@ import DataReader from "./data_reader.ts";
 /**
  * This class represents a binary reader.
  * 
+ * @example
+ * ```
+ * const dataToRead = new Uint8Array([1,2,3,4]);
+ * 
+ * const reader = new BinaryReader(dataToRead.buffer);
+ * 
+ * console.log(reader.read(2)); // ArrayBuffer { [Uint8Contents]: <01 02>, byteLength: 2 }
+ * console.log(reader.bufferLeft.byteLength) // 2
+ * ```
+ * 
  * @extends DataReader
  */
 export default class BinaryReader extends DataReader {

src/data_reader.ts

@@ -1,5 +1,5 @@
 /**
- * This class represents a binary reader. It is similar to DataView but has an internal pointer to
+ * This class represents a data reader. It is similar to DataView but has an internal pointer to
  * automatically pop the bytes that have been already read.
  */
 export default class DataReader {