82 lines
4.4 KiB
Markdown
82 lines
4.4 KiB
Markdown
<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>
|
|
|
|
# vue-fontawesome (with Vue 2)
|
|
|
|
[](https://www.npmjs.com/package/@fortawesome/vue-fontawesome)
|
|
[](https://github.com/FortAwesome/vue-fontawesome/actions)
|
|
|
|
> Font Awesome Vue component using SVG with JS
|
|
|
|
---
|
|
|
|
**If you have been using 0.1.x of vue-fontawesome, you can safely upgrade to
|
|
2.x. We have some upgrading information in the [CHANGELOG](./CHANGELOG.md)**
|
|
|
|
---
|
|
|
|
<!-- 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
|
|
|
|
Helpful Vue links:
|
|
|
|
- [Add Icons with Vue](https://fontawesome.com/docs/web/use-with/vue/add-icons)
|
|
- [Adding Icon Styling with Vue](https://fontawesome.com/docs/web/use-with/vue/style)
|
|
|
|
To find the Vue setup, go to our [Web docs](https://fontawesome.com/docs/web) and click the ***"Set Up with Vue"*** (left hand side menu).
|
|
|
|
## How to Help
|
|
|
|
Review the following docs before diving in:
|
|
|
|
- [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
|
|
|
|
And then:
|
|
|
|
- Check the existing [issues](https://github.com/FortAwesome/vue-fontawesome/issues) 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/GregPeden.png?size=72" /> | Greg Peden | [@GregPeden](https://github.com/GregPeden) |
|
|
| <img src="https://github.com/meteorlxy.png?size=72" /> | Liu Xinyu | [@meteorlxy](https://github.com/meteorlxy) |
|
|
| <img src="https://github.com/schulz3000.png?size=72" /> | Xaver Schulz | [@schulz3000](https://github.com/schulz3000) |
|
|
| <img src="https://github.com/ihmels.png?size=72" /> | Yannick Ihmels | [@ihmels](https://github.com/ihmels) |
|
|
| <img src="https://github.com/btaens.png?size=72" /> | btaens | [@btaens](https://github.com/btaens) |
|
|
| <img src="https://github.com/david-driscoll.png?size=72" /> | David Driscoll | [@david-driscoll](https://github.com/david-driscoll) |
|
|
| <img src="https://github.com/tyranteon.png?size=72" /> | Tyranteon | [@tyranteon](https://github.com/tyranteon) |
|
|
| <img src="https://github.com/parkeyparker.png?size=72" /> | Aaron Parker | [@parkeyparker](https://github.com/parkeyparker) |
|
|
|
|
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/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)
|