diff options
Diffstat (limited to 'themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-free/README.md')
| -rw-r--r-- | themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-free/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-free/README.md b/themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-free/README.md new file mode 100644 index 0000000..8b5d496 --- /dev/null +++ b/themes/docsy/assets/vendor/Font-Awesome/js-packages/@fortawesome/fontawesome-free/README.md @@ -0,0 +1,38 @@ +# @fortawesome/fontawesome-free - The Official Font Awesome 5 NPM package + +> "I came here to chew bubblegum and install Font Awesome 5 - and I'm all out of bubblegum" + +[](https://www.npmjs.com/package/@fortawesome/fontawesome-free) + +## Installation + +``` +$ npm i --save @fortawesome/fontawesome-free +``` + +Or + +``` +$ yarn add @fortawesome/fontawesome-free +``` + +## What's included? + +**This package includes all the same files available through our Free and Pro CDN.** + +* /js - All JavaScript files associated with Font Awesome 5 SVG with JS +* /css - All CSS using the classic Web Fonts with CSS implementation +* /sprites - SVG icons packaged in a convenient sprite +* /scss, /less - CSS Pre-processor files for Web Fonts with CSS +* /webfonts - Accompanying files for Web Fonts with CSS +* /svg - Individual icon files in SVG format + +## Documentation + +Get started [here](https://fontawesome.com/get-started). Continue your journey [here](https://fontawesome.com/how-to-use). + +Or go straight to the [API documentation](https://fontawesome.com/how-to-use/with-the-api). + +## Issues and support + +Start with [GitHub issues](https://github.com/FortAwesome/Font-Awesome/issues) and ping us on [Twitter](https://twitter.com/fontawesome) if you need to. |