<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>

# react-fontawesome

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

> Font Awesome 5 React 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

Official documentation is hosted at fontawesome.com:

[Check it out here](https://fontawesome.com/how-to-use/on-the-web/using-with/react)

## 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                                               |
| :---------------------------------------------------------: | -------------- | ---------------------------------------------------- |
| <img src="https://github.com/NateRadebaugh.png?size=72" />  | Nate Radebaugh | [@NateRadebaugh](https://github.com/NateRadebaugh)   |
|   <img src="https://github.com/kirkbross.png?size=72" />    | Kirk Ross      | [@kirkbross](https://github.com/kirkbross)           |
|                                                             | Prateek Goel   | [@prateekgoel](https://github.com/prateekgoel)       |
|    <img src="https://github.com/naortor.png?size=72" />     | Naor Torgeman  | [@naortor](https://github.com/naortor)               |
|   <img src="https://github.com/mmhand123.png?size=72" />    | Matthew Hand   | [@mmhand123](https://github.com/mmhand123)           |
|    <img src="https://github.com/calvinf.png?size=72" />     | calvinf        | [@calvinf](https://github.com/calvinf)               |
| <img src="https://github.com/chimericdream.png?size=72" />  | Bill Parrott   | [@chimericdream](https://github.com/chimericdream)   |
|    <img src="https://github.com/baelec.png?size=72" />      | Mike Lynch     | [@baelec](https://github.com/baelec)                 |
|   <img src="https://github.com/rodlukas.png?size=72" />     | Lukáš Rod      | [@rodlukas](https://github.com/rodlukas)             |
|   <img src="https://github.com/proudust.png?size=72" />     | Proudust       | [@proudust](https://github.com/proudust)             |
| <img src="https://github.com/TiagoPortfolio.png?size=72" /> | Tiago Sousa    | [@TiagoPortfolio](https://github.com/TiagoPortfolio) |

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

The Font Awesome team:

|                                                            | Name           | GitHub                                             |
| :--------------------------------------------------------: | -------------- | -------------------------------------------------- |
| <img src="https://github.com/supercodepoet.png?size=72" /> | Travis Chase   | [@supercodepoet](https://github.com/supercodepoet) |
|   <img src="https://github.com/robmadole.png?size=72" />   | Rob Madole     | [@robmadole](https://github.com/robmadole)         |
|  <img src="https://github.com/mlwilkerson.png?size=72" />  | Mike Wilkerson | [@mlwilkerson](https://github.com/mlwilkerson)     |
|     <img src="https://github.com/talbs.png?size=72" />     | Brian Talbot   | [@talbs](https://github.com/talbs)                 |
|     <img src="https://github.com/talbs.png?size=72" />     | Brian Talbot   | [@talbs](https://github.com/talbs)                 |
| <img src="https://github.com/jasonlundien.png?size=72" />  | Jason Lundien  | [@jasonlundien](https://github.com/jasonlundien)   |

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

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