# WordPress.org Assets

This directory contains assets for the WordPress.org plugin directory page. These files are **NOT** included in the plugin distribution but are deployed separately to enhance the plugin's presentation on WordPress.org.

## Required Assets

### Plugin Icons

- `icon-128x128.png` - Small icon (128x128 pixels)
- `icon-256x256.png` - Large icon (256x256 pixels, for Retina displays)
- `icon.svg` - (Optional) Vector icon for best quality at any size

### Plugin Banners

- `banner-772x250.png` - Standard resolution banner (772x250 pixels)
- `banner-1544x500.png` - High resolution banner (1544x500 pixels, for Retina displays)

### Screenshots

Screenshots referenced in your `readme.txt` file:

- `screenshot-1.png` - First screenshot
- `screenshot-2.png` - Second screenshot
- `screenshot-3.png` - Third screenshot
- etc.

## Image Guidelines

### File Format

- Use PNG for transparency (icons)
- Use PNG or JPG for banners and screenshots
- SVG is recommended for icons when possible

### Optimization

- Compress images to reduce file size
- Use tools like TinyPNG, ImageOptim, or similar
- Keep total asset folder size under 5MB

### Design Tips

- **Icons**: Use your brand colors, keep it simple and recognizable
- **Banners**: Feature key plugin functionality, use high-quality graphics
- **Screenshots**: Show the plugin in action with clear, annotated examples

## File Naming

Files must be named exactly as shown above. The WordPress.org system looks for these specific filenames.

## Deployment

These assets are automatically deployed to WordPress.org by the `10up/action-wordpress-plugin-deploy` GitHub Action when you create a release. The action will:

1. Upload plugin code from the `build-dir/` to the plugin's `trunk/` and `tags/{version}/`
2. Upload assets from `.wordpress-org/` to the plugin's `assets/` directory

## Resources

- [WordPress.org Plugin Header & Icon Guidelines](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
- [WordPress.org Plugin Banner Guidelines](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/#banners)
- [Screenshot Guidelines](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/#screenshots)