Skip to content

Commit f6523cf

Browse files
committed
Move a bit the README.md
1 parent 9e44360 commit f6523cf

File tree

4 files changed

+502
-99
lines changed

4 files changed

+502
-99
lines changed

src/Icons/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# UX Icons
22

3-
Renders local and remote SVG icons in your Twig templates.
3+
Renders local and remote [SVG icons](https://ux.symfony.com/icons) in your Twig templates.
44

55
```twig
6-
{{ ux_icon('mdi:symfony', {class: 'w-4 h-4'}) }}
7-
{# or #}
6+
{# Twig function.. #}
7+
{{ ux_icon('mdi:check', {class: 'w-4 h-4'}) }}
8+
9+
{# .. or Twig Component #}
810
<twig:UX:Icon name="mdi:check" class="w-4 h-4" />
911
10-
{# renders as: #}
11-
<svg viewBox="0 0 24 24" fill="currentColor" class="w-4 h-4"><path fill="currentColor" d="M21 7L9 19l-5.5-5.5l1.41-1.41L9 16.17L19.59 5.59z"/></svg>
12+
{# Render the "check" icon from "mdi" pack with class #}
13+
<svg viewBox="0 0 24 24" fill="currentColor" class="w-4 h-4">
14+
<path d="M21 7L9 19l-5.5-5.5l1.41-1.41L9 16.17L19.59 5.59z"/>
15+
</svg>
1216
```
1317

14-
Want a demo? Check out https://ux.symfony.com/icons.
15-
16-
**This repository is a READ-ONLY sub-tree split**. See
17-
https://github.com/symfony/ux to create issues or submit pull requests.
18+
Check out [ux.symfony.com/icons](https://ux.symfony.com/icons) for a demo!
1819

1920
## Sponsor
2021

@@ -28,6 +29,10 @@ infrastructure for you!
2829

2930
Help Symfony by [sponsoring][3] its development!
3031

32+
> [!IMPORTANT]
33+
> **This repository is a READ-ONLY sub-tree split**.\
34+
> See https://github.com/symfony/ux to create issues or submit pull requests.
35+
3136
## Resources
3237

3338
- [Documentation](https://symfony.com/bundles/ux-icons/current/index.html)

0 commit comments

Comments
 (0)