Files
2eInk/README.md
patrick 1c5691b957 docs: add project README
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-05-13 18:59:56 -04:00

59 lines
1.5 KiB
Markdown

# 2eInk
Convert images to optimized screensavers for e-ink devices. Runs entirely in your browser - no uploads, no server.
## Features
- **Device Presets** - Pre-configured settings for Kindle, Kobo, reMarkable, and Boox devices
- **Batch Processing** - Convert multiple images at once with parallel Web Workers
- **Privacy First** - All processing happens locally using WebAssembly
- **Customizable Pipeline** - Adjust brightness, contrast, gamma, dithering, and more
- **Live Preview** - Compare original and processed images with an interactive slider
- **Multiple Dithering Algorithms** - Floyd-Steinberg, Atkinson, and ordered dithering
## Supported Devices
| Brand | Models |
|-------|--------|
| Kindle | Paperwhite 5, Paperwhite 4, Oasis 3, Scribe, Basic (2022) |
| Kobo | Clara 2E, Libra 2, Sage |
| reMarkable | reMarkable 2 |
| Boox | Note Air |
Custom device configurations are also supported.
## Usage
1. Select your e-reader from the device dropdown
2. Drop images onto the upload area (JPG, PNG, or WebP)
3. Adjust pipeline settings if needed (optional)
4. Download individual images or all as a ZIP
## Tech Stack
- **Framework** - SvelteKit with Svelte 5 runes
- **Styling** - Tailwind CSS v4
- **Image Processing** - Photon (Rust/WebAssembly)
- **Parallelization** - Web Workers with worker pool
- **Icons** - Lucide
## Development
```bash
# Install dependencies
pnpm install
# Start dev server
pnpm dev
# Build for production
pnpm build
# Preview production build
pnpm preview
```
## License
MIT