inital commit!

README.md

@@ -0,0 +1,63 @@
+# blake3 to wasm
+
+**blake3.wasm** is a WebAssembly port of the BLAKE3 cryptographic hash function written in **Rust**. It enables fast and secure hashing right inside **browsers** and **Node.js**.
+
+## build
+
+```sh
+# lets build it!
+
+# For NodeJS
+wasm-pack build --target nodejs --release
+
+# For the web!
+wasm-pack build --target web --release
+```
+
+SIMD is enabled via `wasm32_simd` feature in `Cargo.toml` and requires:
+```toml
+# .cargo/config.toml
+[target.wasm32-unknown-unknown]
+rustflags = ["-C", "target-feature=+simd128"]
+```
+
+## Usage
+
+```js
+import { hash, hashXof, keyedHash, deriveKey, Hasher } from './pkg/blake3_wasm.js'
+
+const data = new TextEncoder().encode('hello world')
+const key = new Uint8Array(32).fill(1)
+
+// One-shot hashing
+hash(data)
+hashXof(data, 64) // variable output length
+
+// MAC and key derivation
+keyedHash(data, key)
+deriveKey('my context', key)
+
+// Streaming
+const h = new Hasher()
+h.update(data.slice(0, 5))
+h.update(data.slice(5))
+h.finalize()
+```
+
+## Benchmarks
+
+Tested on **Ryzen 7 5800X**, Node.js v24.
+
+| Size  | @noble/hashes | awasm-noble | blake3-wasm |
+|-------|---------------|-------------|-------------|
+| 32 B  | 11 MB/s       | 34 MB/s     | 81 MB/s     |
+| 1 KB  | 60 MB/s       | 360 MB/s    | 781 MB/s    |
+| 64 KB | 49 MB/s       | 1,518 MB/s  | 2,004 MB/s  |
+| 1 MB  | 51 MB/s       | 1,671 MB/s  | 1,893 MB/s  |
+| 10 MB | 51 MB/s       | 1,572 MB/s  | 1,812 MB/s  |
+
+## See also
+
+- [@noble/hashes](https://github.com/paulmillr/noble-hashes) | pure JS implementation
+- [awasm-noble](https://github.com/paulmillr/awasm-noble) | auditable WASM implementation
+- [blake3-napi](https://github.com/UneBaguette/blake3-napi)  | native Node.js addon, faster for large inputs