52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
# Logo Soup
|
|
|
|
Logo Soup is a block-first WordPress plugin for building balanced logo strips and grids directly inside the block editor.
|
|
|
|
## Features
|
|
|
|
- Upload logos from the editor and reorder them with simple move controls.
|
|
- Add optional links per logo.
|
|
- Choose between `carousel` and `grid` layouts.
|
|
- Configure grayscale, animation speed, and hover pause behavior.
|
|
- Set site-wide defaults under `Settings > Logo Soup`.
|
|
- Automatic plugin updates sourced directly from GitHub releases.
|
|
|
|
## Requirements
|
|
|
|
- WordPress 6.1+
|
|
- PHP 7.4+
|
|
|
|
## Development
|
|
|
|
```bash
|
|
composer install
|
|
npm install
|
|
composer phpcs
|
|
composer phpstan
|
|
composer test
|
|
npm run lint:js
|
|
```
|
|
|
|
## Architecture
|
|
|
|
- `logo-soup.php`: plugin bootstrap and autoloader.
|
|
- `src/`: PHP application code.
|
|
- `blocks/logo-soup/`: dynamic block metadata and built assets.
|
|
- `tests/php/`: PHPUnit baseline coverage.
|
|
|
|
## Security
|
|
|
|
- REST mutations require `manage_options` plus a valid `wp_rest` nonce.
|
|
- All settings are sanitized before saving.
|
|
- Block output escapes URLs, attributes, and text on render.
|
|
|
|
## Releases
|
|
|
|
Releases are published automatically when a version tag is pushed to this repository:
|
|
|
|
```bash
|
|
git tag v0.2.0 && git push origin v0.2.0
|
|
```
|
|
|
|
The GitHub Actions release workflow installs production Composer dependencies, packages a distributable zip (`logo-soup-v{version}.zip`), and attaches it to a GitHub Release. WordPress installations with this plugin will receive update notifications via the native admin update system.
|