📄 docs: Add readme, update author name

2026-08-06 18:33:35 -05:00
parent b738d7d6da
commit 3a2d01564e
3 changed files with 79 additions and 1 deletions
@@ -0,0 +1,72 @@
+# SoloFilters Image Enhancements
+
+Add Instagram-style CSS filters to images in the WordPress block editor.
+
+## About
+
+This WordPress plugin registers a new "Filtered Image" block that lets users pick a named filter preset and adjust its intensity. Filters are applied with CSS only, so they are reversible, lightweight, and the original image keeps its alt text.
+
+## Requirements
+
+- WordPress 6.4+
+- PHP 7.4+
+
+## Installation
+
+1. Clone or download this repository to your WordPress plugins directory:
+
+   ```bash
+   wp-content/plugins/solofilters-image-enhancements/
+   ```
+
+2. Activate the plugin from the WordPress admin panel
+
+## Features
+
+- **Filtered Image Block** – A new block type for applying CSS filters to images
+- **Preset Filters** – Choose from multiple named filter presets
+- **Adjustable Intensity** – Control filter intensity with a slider
+- **Non-destructive** – Filters are applied with CSS only; original images remain unchanged
+- **Accessibility** – Alt text is preserved on filtered images
+
+## Development
+
+### Setup
+
+```bash
+npm install
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Testing
+
+Run unit tests:
+
+```bash
+npm run test:jest
+```
+
+Run end-to-end tests:
+
+```bash
+npm run test:e2e
+```
+
+## Changelog
+
+### [0.1.0] - 2026-08-06
+
+- Initial release
+
+## License
+
+GPLv2 or later – [View License](https://www.gnu.org/licenses/gpl-2.0.html)
+
+## Author
+
+[Keith Solomon](https://keithsolomon.net)