Skip to content

Update documentation and version references for v1.0 release #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hamzaydia merged 1 commit into from
Jan 29, 2026
Merged

Update documentation and version references for v1.0 release #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Loading large files in the browser is painful:

1. **Memory explosion** - `crypto.subtle.digest()` buffers the entire file. 4GB AI model = 4GB+ RAM = browser crash.
2. **No fail-fast** - Download 4GB, find corruption at the end, start over.
3. **CDN compromises** - [polyfill.io](https://sansec.io/research/polyfill-supply-chain-attack) affected 100M+ sites.
3. **CDN compromises** - [polyfill.io](https://sansec.io/research/polyfill-supply-chain-attack) affected 100K+ sites.

### The Solution

Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Version | Supported |
| ------- | ------------------ |
| 0.1.x | :white_check_mark: |
| 1.0.x | :white_check_mark: |

## Reporting a Vulnerability

Expand Down Expand Up @@ -55,5 +55,5 @@ When using VerifyFetch:

## Known Limitations

- v0.1 supports hash verification only (signature verification coming in v0.2)
- v1.0 supports hash verification only (signature verification planned for future release)
- SubtleCrypto fallback loads entire file into memory (use WASM for large files)
4 changes: 2 additions & 2 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ This folder contains example projects demonstrating how to use VerifyFetch in di
| Example | Description | Technologies |
|---------|-------------|--------------|
| [node-cli](./node-cli/) | Command-line usage in Node.js | Node.js, ESM |
| [next-app](./next-app/) | React app with custom hook | Next.js 15, React 19 |
| [vite-app](./vite-app/) | Vanilla TypeScript web app | Vite 6, TypeScript |
| [next-app](./next-app/) | React app with custom hook | Next.js 16, React 19 |
| [vite-app](./vite-app/) | Vanilla TypeScript web app | Vite 7, TypeScript |

## Running the Examples

Expand Down