From 1c5691b957c48be0e9b0f810cc51a4a9afc38d46 Mon Sep 17 00:00:00 2001 From: patrick Date: Wed, 13 May 2026 18:59:56 -0400 Subject: [PATCH] docs: add project README Co-Authored-By: Claude Opus 4.5 --- README.md | 86 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 51 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 8634191..a65f283 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,58 @@ -# sv +# 2eInk -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +Convert images to optimized screensavers for e-ink devices. Runs entirely in your browser - no uploads, no server. -## Creating a project +## Features -If you're seeing this, you've probably already done this step. Congrats! +- **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 -```sh -# create a new project -npx sv create my-app +## 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 ``` -To recreate this project with the same configuration: +## License -```sh -# recreate this project -pnpm dlx sv@0.15.3 create --template minimal --types ts --add prettier eslint tailwindcss="plugins:none" sveltekit-adapter="adapter:static" mcp="ide:claude-code+setup:local" --install pnpm . -``` - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```sh -npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` - -## Building - -To create a production version of your app: - -```sh -npm run build -``` - -You can preview the production build with `npm run preview`. - -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +MIT