| 1 | # react-fontawesome
|
| 2 |
|
| 3 | A React component for the font-awesome icon library.
|
| 4 |
|
| 5 |
|
| 6 | ## Features
|
| 7 |
|
| 8 | - No external dependencies on build tools.
|
| 9 | - Not necessary to support ES6 in your application.
|
| 10 | - Packaged for NPM as well as without.
|
| 11 | - Remove the `fa-` prefix from all settings.
|
| 12 |
|
| 13 |
|
| 14 | ## Usage
|
| 15 |
|
| 16 | ```
|
| 17 | var React = require('react');
|
| 18 | var FontAwesome = require('react-fontawesome');
|
| 19 |
|
| 20 | var MyComponent = React.createClass({
|
| 21 | render: function () {
|
| 22 | return (
|
| 23 | <FontAwesome
|
| 24 | name="rocket"
|
| 25 | spin
|
| 26 | size="lg"
|
| 27 | className="super-crazy-colors" />
|
| 28 | );
|
| 29 | }
|
| 30 | });
|
| 31 | ```
|
| 32 |
|
| 33 |
|
| 34 | ## Contributing
|
| 35 |
|
| 36 | Pull requests welcome!
|
| 37 |
|
| 38 | Please use the `.editorconfig`, `.jsfmtrc` and `.jshintrc` configurations in your editor to ensure proper formatting.
|
| 39 |
|
| 40 | Run the test suite with `npm test`, make sure tests are passing and that you write tests for new features.
|
| 41 |
|
| 42 |
|
| 43 | ## Credits
|
| 44 |
|
| 45 | Created by [Dana Woodman](http://danawoodman.com) of [BIG](http://builtbybig.com). Inspired by [react-fa](https://github.com/andreypopp/react-fa).
|
| 46 |
|
| 47 |
|
| 48 | ## License
|
| 49 |
|
| 50 | Licensed under the generous MIT license.
|