Skip to content

Commit 404d05d

Browse files
authored
Update README.md
1 parent 535fd48 commit 404d05d

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,25 +69,35 @@ FA_KIT_TOKEN=************************************
6969

7070
Add the `Font Awesome` Fieldtype to a Blueprint or Fieldset. The Fieldtype provides the option to only make certain icon styles available for selection.
7171

72-
### Template
72+
### Tag
7373

7474
Add the following Tag to the `<head>` of your layout view to render the Font Awesome script.
7575

76-
```html
76+
```antlers
7777
{{ font_awesome:kit }}
7878
```
7979

80-
You may use a different Kit in your template using the `token` parameter.
80+
You may use a different Kit for rendering the icons in your template using the `token` parameter.
8181

82-
```html
82+
```antlers
8383
{{ font_awesome:kit token="f481b75381" }}
8484
```
8585

86-
Use the following Tag to render an icon. In this example `icon` is the variable saved in your content.
86+
Render an icon by using the handle of a Font Awesome field as the wildcard method.
8787

88-
```html
89-
{{ font_awesome:icon }}
88+
```antlers
89+
{{ font_awesome:icon_field }}
9090
```
9191

92+
You may also use the shorter tag alias instead.
93+
94+
```antlers
95+
{{ fa:kit }}
96+
97+
{{ fa:icon_field }}
98+
```
99+
100+
101+
92102
## Credits
93103
Developed by [Michael Aerni](https://www.michaelaerni.ch)

0 commit comments

Comments
 (0)