<a href="https://fontawesome.com">
  <img align="right" width="100" height="100" alt="Official Javascript Component" src="https://img.fortawesome.com/349cfdf6/official-javascript-component.svg">
</a>

# svelte-fontawesome

[![npm](https://img.shields.io/npm/v/@fortawesome/svelte-fontawesome.svg?style=flat-square)](https://www.npmjs.com/package/@fortawesome/svelte-fontawesome)

> Font Awesome Svelte component using SVG with JS

<!-- toc -->

- [Documentation](#documentation)
- [How to Help](#how-to-help)
- [Contributors](#contributors)
- [Releasing this project (only project owners can do this)](#releasing-this-project-only-project-owners-can-do-this)

<!-- tocstop -->

<!-- ## Documentation -->

## Compatibility
| Svelte version | svelte-fontawesome version |
| - | - |
| >= 3.x | 0.2.x |

_Documentation is not currently available. Check out the `examples` directory to get started._

_We'll be working on documentation (either in this repo or on fontawesome.com) when time allows._

## How to Help

Review the following docs before diving in:

- [CONTRIBUTING.md](CONTRIBUTING.md)
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)

And then:

1.  Check the existing issue and see if you can help!

## Contributors

The following contributors have either helped to start this project, have contributed
code, are actively maintaining it (including documentation), or in other ways
being awesome contributors to this project. **We'd like to take a moment to recognize them.**

| Name              | GitHub                                                     |
| ----------------- | ---------------------------------------------------------- |
| Sean Timm         | [@seantimm](https://github.com/seantimm)                   |
| Akiomi Kamakura   | [@akiomik](https://github.com/akiomik)                     |
| Daniel Senff      | [@Dahie](https://github.com/Dahie)                         |
| Konnng Digital    | [@konnng-dev](https://github.com/konnng-dev)               |
| Martin Blasko     | [@MartinBspheroid](https://github.com/MartinBspheroid)     |
| Font Awesome Team | [@FortAwesome](https://github.com/orgs/FortAwesome/people) |

If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.

## Releasing this project (only project owners can do this)

See [DEVELOPMENT.md](DEVELOPMENT.md#release)
