update documentation

Author: hcortezr

.github/workflows/publish.yml

@@ -1,26 +1,56 @@
-name: Publish to NPM
+name: Publish to NPM and GitHub Pages
 
 on:
     release:
         types: [created]
 
+permissions:
+    contents: read
+    id-token: write
+
 jobs:
     build:
         runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            id-token: write
         steps:
             - uses: actions/checkout@v4
-            - uses: oven-sh/setup-bun@v1
+
+            - name: Setup Bun
+              uses: oven-sh/setup-bun@v1
               with:
                   bun-version: latest
-            - uses: actions/setup-node@v4
+
+            - name: Setup Node
+              uses: actions/setup-node@v4
               with:
                   node-version: "20.x"
                   registry-url: "https://registry.npmjs.org"
-            - run: bun install
-            - run: bun run build
-            - run: npm publish --provenance --access public
+
+            - name: Install Dependencies
+              run: bun install
+
+            - name: Build BinaryStream
+              run: bun run build
+
+            - name: Publish to NPM
+              run: npm publish --provenance --access public
               env:
                   NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+            - name: Build Docs
+              run: bun run docs
+
+            - name: Upload Docs to GitHub Pages
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  artifact-name: docs
+                  path: docs/
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.gitignore

@@ -173,3 +173,5 @@ dist
 
 # Finder (MacOS) folder config
 .DS_Store
+
+docs/

README.md

@@ -1,17 +1,17 @@
 # BinaryStream
 
-`BinaryStream` is a TypeScript package designed to facilitate the reading and writing of binary data. This package leverages the `ArrayBuffer` and `DataView` interfaces, making it compatible with both Node.js and browser environments.
+`BinaryStream` is an Typescript module designed to facilitate the reading and writing of binary data. This package uses the [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) and [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) interfaces, both of which are native to Javascript making it compatible with Node.js and browser environments.
 
 ## Features
 
 -   Supports both Node.js and browser environments.
 -   Provides an easy-to-use API for handling binary data.
 -   Methods for reading and writing various data types (integers, floats, strings, etc.).
--   Allows for dynamic buffer creation without worrying about resizing.
+-   Allows for dynamic buffer creation without worrying about sizing.
 
 ## Installation
 
-You can install the `BinaryStream` package via npm:
+You can install the `BinaryStream` package via npm.
 
 ```bash
 npm install @pocketnode/binarystream
@@ -27,36 +27,41 @@ bun install @pocketnode/binarystream
 
 ### Importing the Module
 
-In a TypeScript or JavaScript file, import the `BinaryStream` module:
-
 ```typescript
+// Node.js, Bun, etc.
 import BinaryStream from "@pocketnode/binarystream";
-// or through CDN
-import BinaryStream from "https://unpkg.com/@pocketnode/binarystream@latest/dist/BinaryStream.js";
+
+// Browser from CDN
+import BinaryStream from "https://esm.run/@pocketnode/binarystream@latest/dist/BinaryStream.js";
 ```
 
-### Creating a BinaryStream Instance
+### Creating an Instance
 
 To create a new instance of `BinaryStream`, you can either provide an existing `ArrayBuffer` or specify the size of a new buffer:
 
 ```typescript
-// Create a BinaryStream with a new ArrayBuffer of 1024 bytes
-const stream = new BinaryStream(1024);
+// Create an empty BinaryStream
+const stream = new BinaryStream();
+
+// Create a BinaryStream from an array of bytes
+const bytes = BinaryStream.from([0xde, 0xad, 0xbe, 0xef]);
+bytes.toString("hex"); // deadbeef
+
+// Create a BinaryStream from a string
+const str = BinaryStream.from("\xde\xad\xbe\xef", "binary");
+str.toString("hex"); // deadbeef
 
 // Create a BinaryStream from an existing ArrayBuffer
-const buffer = new ArrayBuffer(1024);
-const streamFromBuffer = new BinaryStream(buffer);
+const blob = new Blob(..., {type: "application/octet-stream"});
+const streamFromBuffer = BinaryStream.from(await blob.arrayBuffer());
 ```
 
 ### Example
 
-Here is a complete example demonstrating how to write and read data using `BinaryStream`:
+Here is an example demonstrating how to write and read data using `BinaryStream`:
 
 ```typescript
-import BinaryStream from "@pocketnode/binarystream";
-
-// Create a BinaryStream with a new ArrayBuffer of 1024 bytes
-const stream = new BinaryStream(1024);
+const stream = new BinaryStream();
 
 // Write data to the stream
 stream.writeUInt8(255);
@@ -77,12 +82,9 @@ console.log(uint8); // 255
 console.log(int16); // -32768
 console.log(float32); // 3.14
 console.log(str); // Hello, BinaryStream!
+console.log(stream.buffer); // Uint8Array (31) [255, 128, 0, 64, 72, 245, 195, 0, 0, 0, 20, 72, 101, 108, 108, 111, 44, 32, 66, 105, 110, 97, 114, 121, 83, 116, 114, 101, 97, 109, 33]
 ```
 
-## Compatibility
-
-`BinaryStream` works in both Node.js and browser environments. It relies on `ArrayBuffer` and `DataView`, which are available in [modern browsers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/transfer#browser_compatibility) and Node.js.
-
 ## License
 
 This project is licensed under the GNU GPLv3 License. See the [LICENSE](LICENSE) file for details.

bun.lockb

@@ -17,18 +17,20 @@
         "node"
     ],
     "scripts": {
-        "build": "bun run build.ts"
+        "build": "bun run build.ts",
+        "docs": "typedoc --plugin typedoc-plugin-mdn-links --plugin typedoc-material-theme --out docs --name BinaryStream --readme README.md --themeColor '#1B1D68' ./dist/BinaryStream.d.ts"
     },
     "license": "GPL-3.0-only",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/pocketnode/binarystream.git"
     },
     "devDependencies": {
+        "typescript": "^5.0.0",
         "bun-plugin-dts": "^0.2.3",
-        "bun-types": "latest"
-    },
-    "peerDependencies": {
-        "typescript": "^5.0.0"
+        "bun-types": "latest",
+        "type-doc": "^0.1.41",
+        "typedoc-material-theme": "^1.0.2",
+        "typedoc-plugin-mdn-links": "^3.1.28"
     }
 }

package.json

@@ -0,0 +1,14 @@
+declare global {
+    interface ArrayBuffer {
+        transfer(size: number): ArrayBuffer;
+    }
+}
+
+if (!ArrayBuffer.prototype.transfer) {
+    ArrayBuffer.prototype.transfer = function (size: number): ArrayBuffer {
+        const buffer = new ArrayBuffer(size);
+        const view = new Uint8Array(buffer);
+        view.set(new Uint8Array(this, 0, size));
+        return buffer;
+    };
+}