Skip to content

feat: add lite version for non-WASM environments #4

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

Draft
agessaman wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add lite version for non-WASM environments #4

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
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,37 @@ npm install @michaelhart/meshcore-decoder
npm install -g @michaelhart/meshcore-decoder
```

## Lite Version (No WASM)

A pure JavaScript build is available for environments without WASM or Web Crypto API (e.g., HTTP pages, embedded browsers):

```typescript
import { MeshCoreDecoder } from '@michaelhart/meshcore-decoder/lite';
```

**Standalone bundle** for direct `<script>` use:

```bash
npm run build:lite # Creates dist/meshcore-lite.min.mjs (120kb)
```

```html
<script type="module">
import { decodePacket } from './meshcore-lite.min.mjs';
const packet = decodePacket('04001234...');
</script>
```

| Feature | Main | Lite |
|---------|------|------|
| Packet decoding | ✅ | ✅ |
| GroupText decryption | ✅ | ✅ |
| Signature verification | ✅ | ✅ |
| Auth token signing | ✅ | ❌ |
| Key derivation (orlp) | ✅ | ❌ |
| Works on HTTP | ❌ | ✅ |
| Requires WASM | ✅ | ❌ |

## Quick Start

```typescript
Expand Down
Loading