Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronHolbrook authored Aug 30, 2018
1 parent a7b5aec commit 731dcfd
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
# Icons
> Simple, easy to use icons.
Simply find the icon you want to use from here: https://feathericons.com/ and use it by calling:
Simply find the icon you want to use from either of these icon sets:

* [Feather Icons](https://feathericons.com/)
* [Box Icons](https://boxicons.com)

## Usage

The icon pack will default to the Feather Icon pack.


Feather 'Archive' Icon:
```php
\Zeek\Icons\get_svg_path( 'archive' );
```
> ![Archive SVG Icon](./assets/img/svg/feather/archive.svg)
Box Icons 'Archive' Icon:
```php
\Zeek\Icons\get_svg_path( 'icon' );
```
\Zeek\Icons\get_svg_path( 'bx-archive', 'boxicons' );
```
> ![Archive SVG Icon](./assets/img/svg/boxicons/bx-archive.svg)

0 comments on commit 731dcfd

Please sign in to comment.