stormlib-js 0.1.0 → 0.1.1

package/README.md

@@ -69,6 +69,22 @@ for (const entry of results) {
 archive.close();
 ```
 
+Browser or in-memory usage:
+
+```typescript
+import { MpqArchive } from 'stormlib-js/browser';
+
+const file = input.files?.[0];
+if (!file) throw new Error('No file selected');
+
+const arrayBuffer = await file.arrayBuffer();
+const archive = MpqArchive.openFromBuffer(arrayBuffer);
+const war3mapJ = archive.extractFile('war3map.j');
+archive.close();
+```
+
+`stormlib-js/browser` is browser-safe and does not include Node `fs` loading code.
+
 ## API
 
 ### `MpqArchive`
@@ -79,6 +95,8 @@ The main class for working with MPQ archives.
 
 Opens an MPQ archive from a file path.
 
+> In `stormlib-js/browser`, `MpqArchive.open()` throws by design. Use `openFromBuffer()`.
+
 ```typescript
 const archive = MpqArchive.open('archive.mpq');
 
@@ -91,6 +109,17 @@ const archive = MpqArchive.open('archive.mpq', {
 });
 ```
 
+#### `MpqArchive.openFromBuffer(data, options?)`
+
+Opens an MPQ archive from in-memory binary data (`ArrayBuffer`, `Uint8Array`, or `Buffer`).
+
+```typescript
+import { MpqArchive } from 'stormlib-js/browser';
+
+const arrayBuffer = await file.arrayBuffer();
+const archive = MpqArchive.openFromBuffer(arrayBuffer);
+```
+
 #### `archive.hasFile(name)`
 
 Returns `true` if the file exists in the archive.