UNPKG

2.75 kBMarkdownView Raw
1<a href="https://fontawesome.com">
2 <img align="right" width="100" height="100" alt="Official Javascript Component" src="https://img.fortawesome.com/349cfdf6/official-javascript-component.svg">
3</a>
4
5# react-fontawesome
6
7[![npm](https://img.shields.io/npm/v/@fortawesome/react-fontawesome.svg?style=flat-square)](https://www.npmjs.com/package/@fortawesome/react-fontawesome)
8
9> Font Awesome 5 React component using SVG with JS
10
11<!-- toc -->
12
13- [Documentation](#documentation)
14- [How to Help](#how-to-help)
15- [Contributors](#contributors)
16- [Releasing this project (only project owners can do this)](#releasing-this-project-only-project-owners-can-do-this)
17
18<!-- tocstop -->
19
20## Documentation
21
22Official documentation is hosted at fontawesome.com:
23
24[Check it out here](https://fontawesome.com/v6/docs/web/use-with/react/)
25
26## How to Help
27
28Review the following docs before diving in:
29
30- [CONTRIBUTING.md](CONTRIBUTING.md)
31- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
32
33And then:
34
351. Check the existing issue and see if you can help!
36
37## Contributors
38
39The following contributors have either helped to start this project, have contributed
40code, are actively maintaining it (including documentation), or in other ways
41being awesome contributors to this project. **We'd like to take a moment to recognize them.**
42
43| Name | GitHub |
44| ----------------- | --------------------------------------------------------- |
45| Nate Radebaugh | [@NateRadebaugh](https://github.com/NateRadebaugh) |
46| Kirk Ross | [@kirkbross](https://github.com/kirkbross) |
47| Prateek Goel | [@prateekgoel](https://github.com/prateekgoel) |
48| Naor Torgeman | [@naortor](https://github.com/naortor) |
49| Matthew Hand | [@mmhand123](https://github.com/mmhand123) |
50| calvinf | [@calvinf](https://github.com/calvinf) |
51| Bill Parrott | [@chimericdream](https://github.com/chimericdream) |
52| Mike Lynch | [@baelec](https://github.com/baelec) |
53| Lukáš Rod | [@rodlukas](https://github.com/rodlukas) |
54| Proudust | [@proudust](https://github.com/proudust) |
55| Tiago Sousa | [@TiagoPortfolio](https://github.com/TiagoPortfolio) |
56| Alexey Victorov | [@AliMamed](https://github.com/AliMamed) |
57| Font Awesome Team | [@FortAwesome](https://github.com/orgs/FortAwesome/people)|
58
59If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.
60
61## Releasing this project (only project owners can do this)
62
63See [DEVELOPMENT.md](DEVELOPMENT.md#release)