@huh-david/bmp-js 0.3.0 → 0.4.1

package/README.md

@@ -2,11 +2,19 @@
 
 A pure TypeScript BMP encoder/decoder for Node.js.
 
+## Maintenance
+
+This fork is actively maintained and tracks unresolved upstream `shaozilee/bmp-js` issues and PRs.
+
+- Repository: https://github.com/Huh-David/bmp-js
+- Latest release: https://github.com/Huh-David/bmp-js/releases/tag/v0.4.0
+
 ## Features
 
 - Decoding for BMP bit depths: 1, 4, 8, 15, 16, 24, 32
 - Decoding support for RLE-4 and RLE-8 compressed BMPs
-- Encoding output as 24-bit BMP
+- Robust DIB handling for CORE/INFO/V4/V5 headers
+- Encoding output as 24-bit BMP with configurable orientation
 - Dual package output: ESM + CommonJS
 - First-class TypeScript types
 
@@ -36,6 +44,24 @@ const encoded = encode({
 writeFileSync("./roundtrip.bmp", encoded.data);
 ```
 
+### Encode options
+
+```ts
+import { encode } from "@huh-david/bmp-js";
+
+const encoded = encode(
+  {
+    data: rgbaLikeBytes,
+    width: 320,
+    height: 200,
+  },
+  {
+    orientation: "bottom-up", // default: "top-down"
+    bitPP: 24, // only 24 is currently supported
+  },
+);
+```
+
 ### CommonJS
 
 ```js
@@ -48,19 +74,33 @@ const encoded = bmp.encode(decoded);
 fs.writeFileSync("./roundtrip.bmp", encoded.data);
 ```
 
+### Decode options
+
+```ts
+import { decode } from "@huh-david/bmp-js";
+
+const decoded = decode(inputBytes, {
+  toRGBA: true, // return RGBA instead of default ABGR
+});
+```
+
 ## Data layout
 
-Decoded pixel data is a byte buffer in `ABGR` order.
+Decoded pixel data is a byte buffer in `ABGR` order by default.
+If `toRGBA: true` is provided to `decode`, output is returned in `RGBA`.
 
 - `A`: alpha
 - `B`: blue
 - `G`: green
 - `R`: red
 
+Input/output binary types use `Uint8Array` (Node `Buffer` is fully compatible because it extends `Uint8Array`).
+
 ## Development
 
 ```bash
 pnpm install
+pnpm fixtures:generate
 pnpm check
 ```