100 lines
5.5 KiB
Markdown
100 lines
5.5 KiB
Markdown
<h1><img src="https://img.fortawesome.com/349cfdf6/logo-fa-pro.svg" alt="Font Awesome 5" width="50%"></h1>
|
|
|
|
The internet's most popular icon toolkit is being redesigned and built from scratch. On top of this, Font Awesome Pro adds thousands more icons and features like icon font ligatures, an SVG framework, community voting/support, and access to a new CDN.
|
|
|
|
Not familiar with Font Awesome 5? [Learn more](https://www.kickstarter.com/projects/232193852/font-awesome-5) about our successful Kickstarter and plan. You can also **[order Font Awesome Pro](https://fontawesome.com/pro)** directly from fontawesome.com.
|
|
|
|
## Documentation
|
|
|
|
Learn how to get started with Font Awesome and then dive deeper into other and advanced topics:
|
|
|
|
### Using Font Awesome on the Web
|
|
|
|
* [With SVG with JavaScript](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=svg-with-js)
|
|
* [With web fonts with CSS](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=web-fonts-with-css)
|
|
* [Upgrading from version 4](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4)
|
|
* [Installing Font Awesome with a package manager](https://fontawesome.com/how-to-use/on-the-web/setup/using-package-managers)
|
|
* [Downloading + hosting Font Awesome yourself](https://fontawesome.com/how-to-use/on-the-web/setup/hosting-font-awesome-yourself)
|
|
* [Performance and security](https://fontawesome.com/how-to-use/performance-and-security)
|
|
* [Accessibility](https://fontawesome.com/how-to-use/on-the-web/other-topics/accessibility)
|
|
* [Troubleshooting](https://fontawesome.com/how-to-use/on-the-web/other-topics/troubleshooting)
|
|
|
|
#### Advanced Options & Techniques
|
|
|
|
* [Using CSS pseudo-elements](https://fontawesome.com/how-to-use/on-the-web/advanced/css-pseudo-elements)
|
|
* [SVG sprites](https://fontawesome.com/how-to-use/svg-sprites)
|
|
* [The Font Awesome API](https://fontawesome.com/how-to-use/font-awesome-api)
|
|
* [SVG symbols](https://fontawesome.com/how-to-use/on-the-web/advanced/svg-symbols)
|
|
* [SVG JavaScript Core](https://fontawesome.com/how-to-use/on-the-web/advanced/svg-javascript-core)
|
|
* [Server side rendering](https://fontawesome.com/how-to-use/server-side-rendering)
|
|
|
|
### Using Font Awesome on the Desktop
|
|
|
|
* [Getting started](https://fontawesome.com/how-to-use/on-the-desktop/setup/getting-started)
|
|
* [Upgrading from version 4](https://fontawesome.com/how-to-use/on-the-desktop/setup/upgrading-from-version-4)
|
|
* [Using ligatures](https://fontawesome.com/how-to-use/on-the-desktop/referencing-icons/using-ligatures)
|
|
* [Using glyphs](https://fontawesome.com/how-to-use/on-the-desktop/referencing-icons/using-glyphs)
|
|
* [Troubleshooting](https://fontawesome.com/how-to-use/on-the-desktop/other-topics/troubleshooting)
|
|
|
|
## 5.4.2 release
|
|
|
|
Login to your https://fontawesome.com account to download the latest version of Font Awesome Pro.
|
|
|
|
## Change log
|
|
|
|
We'll keep track of each release in the [CHANGELOG.md](./CHANGELOG.md)
|
|
|
|
Looking for older versions of Font Awesome? Check the [releases](https://github.com/FortAwesome/Font-Awesome-Pro/releases)
|
|
|
|
## Code of conduct
|
|
|
|
We will behave ourselves if you behave yourselves. For more details see our
|
|
[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
|
|
|
|
## Contributing
|
|
|
|
Please read through our [contributing guidelines](./CONTRIBUTING.md). Included
|
|
are directions for opening issues.
|
|
|
|
## Versioning
|
|
|
|
Font Awesome Pro will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
|
|
with the following format:
|
|
|
|
`<major>.<minor>.<patch>`
|
|
|
|
For more information on SemVer, please visit http://semver.org.
|
|
|
|
**The major version "5" is part of an umbrella release. It includes many different types of files and technologies. Therefore
|
|
we deviate from normal SemVer in the following ways:**
|
|
|
|
* Any release may update the design, look-and-feel, or branding of an existing
|
|
icon
|
|
* We will never intentionally release a `patch` version update that breaks
|
|
backward compatibility
|
|
* A `minor` release **may include backward-incompatible changes** but we will
|
|
write clear upgrading instructions in UPGRADING.md
|
|
* A `minor` or `patch` release will never remove icons
|
|
* Bug fixes will be addressed as `patch` releases unless they include backward
|
|
incompability then they will be `minor` releases
|
|
|
|
## Copyright and License
|
|
The icons, code, and assets included in project are licensed under the Font Awesome Pro commercial license - see [this project's license file](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md) for details.
|
|
|
|
## Questions and Contact Us
|
|
Font Awesome Pro received backing by thousands of people (thanks again!). With that said, addressing each and every question is a lot of work and the more the community and documentation can help each other, the more we can use that time to focus on getting Pro features out. If you do need to reach out to us, here's how to do it:
|
|
|
|
* **General/Business inquiries** - email hello@fontawesome.com
|
|
* **Account/Billing-related inquiries** - email hello@fontawesome.com
|
|
* **Questions about [our Kickstarter](https://www.kickstarter.com/projects/232193852/font-awesome-5) campaign** - If you are a backer (thanks, btw!), please reply to individual updates or send a message through Kickstarter.
|
|
|
|
## Team
|
|
|
|
* [Dave Gandy](https://github.com/davegandy)
|
|
* [Travis Chase](https://github.com/supercodepoet)
|
|
* [Rob Madole](https://github.com/robmadole)
|
|
* [Brian Talbot](https://github.com/talbs)
|
|
* [Jory Raphael](https://github.com/sensibleworld)
|
|
* [Mike Wilkerson](https://github.com/mlwilkerson)
|
|
* [Geremia Taglialatela](https://github.com/tagliala)
|