UNPKG

4.25 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/how-to-use/on-the-web/using-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| <img src="https://github.com/NateRadebaugh.png?size=72" /> | Nate Radebaugh | [@NateRadebaugh](https://github.com/NateRadebaugh) |
46| <img src="https://github.com/kirkbross.png?size=72" /> | Kirk Ross | [@kirkbross](https://github.com/kirkbross) |
47| | Prateek Goel | [@prateekgoel](https://github.com/prateekgoel) |
48| <img src="https://github.com/naortor.png?size=72" /> | Naor Torgeman | [@naortor](https://github.com/naortor) |
49| <img src="https://github.com/mmhand123.png?size=72" /> | Matthew Hand | [@mmhand123](https://github.com/mmhand123) |
50| <img src="https://github.com/calvinf.png?size=72" /> | calvinf | [@calvinf](https://github.com/calvinf) |
51| <img src="https://github.com/chimericdream.png?size=72" /> | Bill Parrott | [@chimericdream](https://github.com/chimericdream) |
52| <img src="https://github.com/baelec.png?size=72" /> | Mike Lynch | [@baelec](https://github.com/baelec) |
53| <img src="https://github.com/rodlukas.png?size=72" /> | Lukáš Rod | [@rodlukas](https://github.com/rodlukas) |
54| <img src="https://github.com/proudust.png?size=72" /> | Proudust | [@proudust](https://github.com/proudust) |
55| <img src="https://github.com/TiagoPortfolio.png?size=72" /> | Tiago Sousa | [@TiagoPortfolio](https://github.com/TiagoPortfolio) |
56
57If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.
58
59The Font Awesome team:
60
61| | Name | GitHub |
62| :--------------------------------------------------------: | -------------- | -------------------------------------------------- |
63| <img src="https://github.com/supercodepoet.png?size=72" /> | Travis Chase | [@supercodepoet](https://github.com/supercodepoet) |
64| <img src="https://github.com/robmadole.png?size=72" /> | Rob Madole | [@robmadole](https://github.com/robmadole) |
65| <img src="https://github.com/mlwilkerson.png?size=72" /> | Mike Wilkerson | [@mlwilkerson](https://github.com/mlwilkerson) |
66| <img src="https://github.com/talbs.png?size=72" /> | Brian Talbot | [@talbs](https://github.com/talbs) |
67| <img src="https://github.com/jasonlundien.png?size=72" /> | Jason Lundien | [@jasonlundien](https://github.com/jasonlundien) |
68
69## Releasing this project (only project owners can do this)
70
71See [DEVELOPMENT.md](DEVELOPMENT.md#release)