Metadata-Version: 2.4
Name: wagtail-font-awesome-svg
Version: 1.1
Summary: Font Awesome icons as SVG for Wagtail
Home-page: https://github.com/wagtail-nest/wagtail-font-awesome-svg
Author: Coen van der Kamp
Author-email: coen@fourdigits.nl
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: SIL Open Font License 1.1 (OFL-1.1)
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 5
Classifier: Framework :: Wagtail :: 6
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# Wagtail Font Awesome SVG

Add [Font Awesome](https://fontawesome.com/icons?d=gallery&m=free) SVG icons to your Wagtail project.

## Install

```sh
pip install wagtail-font-awesome-svg
```

Add `wagtailfontawesomesvg` to your installed apps.

```python
INSTALLED_APPS = [
    'wagtailfontawesomesvg',
]
```

## Usage

This is an [overview of available icons](https://fontawesome.com/icons?d=gallery&m=free). 
Choose an icon and add it via your `wagtail_hooks.py`:

```python
from wagtail import hooks

@hooks.register("register_icons")
def register_icons(icons):
    return icons + [
        'wagtailfontawesomesvg/brands/facebook.svg',
        'wagtailfontawesomesvg/regular/face-laugh.svg',
        'wagtailfontawesomesvg/solid/yin-yang.svg',
        ...
    ]
```
