Update README

This commit is contained in:
brabli
2023-06-26 21:31:22 +01:00
parent 19076b58e1
commit f33bf7ce6a

View File

@@ -4,7 +4,7 @@ Use icons inside of Twig templates with ease! Project must be using Tailwind for
```php
{{ icon({ icon: 'person' }) }}
{{ pcm_icon({ icon: 'person' }) }}
```
## Config
@@ -12,6 +12,9 @@ Example config:
```yaml
# config/packages/pcm_icon.yaml
pcm_icon:
default:
size: 32
colour: primary
directories:
- '%kernel.project_dir%/public/icons'
colours:
@@ -30,6 +33,7 @@ pcm_icon:
fill-group-hover: 'group-hover:fill-red-800'
stroke-group-hover: 'group-hover:stroke-red-800'
```
# @TODO default options
`directories` - Which directories to look in for icons.