Skip to content

Commit 4082041

Browse files
Update readme
1 parent 633aeaf commit 4082041

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

readme.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
A PHP class that can be used to add [Font Awesome 5+](https://fontawesome.com/)'s SVG icons inline without Javascript.
44

5+
## Installation
6+
7+
You can install it using Composer:
8+
9+
```
10+
composer require husseinalhammad/fontawesome-svg
11+
```
12+
13+
Or you can download the `FontAwesomeSVG.php` file and include it manually.
14+
515

616
## Usage
717

@@ -56,7 +66,13 @@ echo $FA->get_svg('fas fa-file', [
5666
]);
5767
```
5868

59-
69+
| Option | What it means |
70+
|-----------------------|--------------------------------------------------------------------------|
71+
| class | Adds classes to the SVG tag |
72+
| default_class | If set to `false`, the default CSS class won't be added to the SVG tag. Deafult: `true`. |
73+
| title | Adds a `<title>` inside the SVG tag for semantic icons |
74+
| role | The value of the `role` attribute in the SVG tag. Default: `img` |
75+
| fill | The value of the `fill` attribute in the `<path>` inside the SVG. Default: `currentColor` |
6076

6177

6278
## Accessibility

0 commit comments

Comments
 (0)