brackt/public/sports-icons/README.md

34 lines
1.1 KiB
Markdown

# Sports Icons Directory
This directory contains icon files for sports. Icons are referenced in the database by filename only.
## Usage
Icons are automatically uploaded through the admin panel when creating or editing sports:
1. Go to Admin > Sports > Add/Edit Sport
2. Use the "Icon File" upload field to select an SVG, PNG, or JPG file
3. The file will be automatically saved as `{slug}.{extension}` in this directory
You can also manually place icon files here if needed.
## File Format
- **Preferred**: SVG files for scalability
- **Supported**: PNG files (recommend 512x512px or higher)
- **Naming**: Use the sport slug as the filename (e.g., `nfl.svg`, `golf-mens.svg`)
## Import/Export
When exporting sports data:
- This entire directory should be included in the export
- The export script will copy all files from this directory
When importing sports data:
- Extract the `sports-icons` folder to `/public/sports-icons/`
- The import script will update database references to match the imported files
## Access
Icons are served from `/sports-icons/{filename}` in the application.
Example: `/sports-icons/nfl.svg`