updatedocs

Author: hawkkiller

AGENTS.md

@@ -1,6 +1,7 @@
 # Pixer
 
-Cross-platform image manipulation library: Dart API backed by Rust via FFI.
+Pixer is a cross-platform library for image manipulation: resize, crop, rotate, create thumbnails, combine images, and more.
+It uses Rust's image crate via FFI to provide high-performance image processing.
 
 ## Project Structure
 
@@ -9,13 +10,12 @@ Cross-platform image manipulation library: Dart API backed by Rust via FFI.
 - `/packages/benchmarks` - Performance benchmarks
 - `/packages/upscale_flutter` - Flutter demo app
 
-## Commands
+## Useful Commands
 
 ```bash
 # Build native library locally
-dart tool/build.dart -o<os> -a<arch>
 # Examples: -omacos -aarm64, -olinux -ax64, -oandroid -aarm64
-
+dart tool/build.dart -o<os> -a<arch>
 # Generate FFI bindings (after changing native/src/ffi.rs)
 dart run ffigen --config ffigen.yaml
 ```
@@ -28,6 +28,6 @@ dart run ffigen --config ffigen.yaml
 
 ## Architecture
 
-- Rust code in `native/src/`: `lib.rs` (entry), `api.rs` (image ops), `ffi.rs` (C bindings)
+- Rust code in `native/src/`: `lib.rs` (entry), `api.rs` (image ops), `ffi.rs` (C-compatible API)
 - Dart bindings generated via ffigen into `lib/src/bindings/`
 - Native assets delivered via Dart build hooks (see `hook/` directory)

README.md

@@ -0,0 +1,5 @@
+# Pixer
+
+Fast, cross-platform image manipulation for Dart, powered by Rust via FFI.
+
+See the [package README](packages/pixer/README.md) for full documentation, API usage, and [roadmap](packages/pixer/README.md#roadmap).

packages/pixer/README.md

@@ -132,4 +132,42 @@ All errors throw typed `PixerException` subclasses:
 
 ## Platforms
 
-Linux, macOS, Windows, Android, iOS
+Linux, macOS, Windows, Android, iOS
+
+## Roadmap
+
+### Current (v0.0.x)
+- [x] Load/save: PNG, JPEG, GIF, WebP, BMP, ICO, TIFF
+- [x] Resize (aspect-ratio-preserving & exact) with 5 filter types
+- [x] Crop, rotate (90/180/270), flip (H/V)
+- [x] Adjustments: blur, brightness, contrast, grayscale, invert
+- [x] Metadata access (width, height, color type)
+- [x] Full platform support (Linux, macOS, Windows, Android, iOS)
+
+### Planned — `image` crate
+- [ ] Encoding quality/compression options (JPEG quality, PNG compression level)
+- [ ] Hue rotation
+- [ ] Sharpen / unsharp mask
+- [ ] Thumbnail generation (optimized fast path)
+- [ ] Create blank images (solid color, transparent)
+- [ ] Composite images (overlay one image onto another at x, y)
+- [ ] Tiling
+- [ ] Animated GIF/WebP frame-level control
+- [ ] Batch processing API
+
+### Planned — requires `imageproc`
+- [ ] Arbitrary angle rotation
+- [ ] Blend modes (multiply, screen, overlay, etc.)
+- [ ] Draw primitives (rectangles, circles, lines)
+- [ ] Text rendering onto images
+- [ ] Edge detection (Canny, Sobel)
+- [ ] Content-aware resize (seam carving)
+
+### Planned — requires other crates
+- [ ] EXIF metadata read/write/preserve (e.g. `kamadak-exif`)
+- [ ] Stitch images (horizontal/vertical concat, grid layout)
+- [ ] Watermarking
+
+### Exploring
+- [ ] Advanced color adjustments (saturation, gamma, curves)
+- [ ] GPU acceleration