Merge pull request #13431 from FortAwesome/update-readme
|2 weeks ago|
|.github||5 months ago|
|advanced-options||3 weeks ago|
|svg-with-js||3 weeks ago|
|use-on-desktop||3 weeks ago|
|web-fonts-with-css||3 weeks ago|
|CHANGELOG.md||3 weeks ago|
|CODE_OF_CONDUCT.md||5 months ago|
|CONTRIBUTING.md||5 months ago|
|LICENSE.txt||5 months ago|
|README.md||2 weeks ago|
|UPGRADING.md||3 weeks ago|
Version 5 – the iconic SVG, font, and CSS framework
The internet's most popular icon toolkit has been redesigned and built from scratch. On top of this, features like icon font ligatures, an SVG framework, official NPM packages for popular frontend libraries like React, and access to a new CDN.
Learn how to get started with Font Awesome and then dive deeper into other and advanced topics:
Now that Font Awesome 5 has been released we are marking version 4 as end-of-life. We don't plan on releasing any further versions of the 4.x or 3.x.
We'll keep track of each release in the CHANGELOG.md
Looking for older versions of Font Awesome? Check the releases.
From time-to-time we'll have special upgrading instructions from one version to the next.
Check out the UPGRADING.md guide when you upgrade your dependencies.
We will behave ourselves if you behave yourselves. For more details see our CODE_OF_CONDUCT.md.
Please read through our contributing guidelines. Included are directions for opening issues.
Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:
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:
patchversion update that breaks backward compatibility
minorrelease may include backward-incompatible changes but we will write clear upgrading instructions in UPGRADING.md
patchrelease will never remove icons
patchreleases unless they include backward incompability then they will be
Font Awesome Free is free, open source, and GPL friendly. You can use it for commercial projects, open source projects, or really almost whatever you want.
Attribution is required by MIT, SIL OLF, and CC BY licenses. Downloaded Font Awesome Free files already contain embedded comments with sufficient attribution, so you shouldn't need to do anything additional when using these files normally.
We've kept attribution comments terse, so we ask that you do not actively work to remove them from files, especially code. They're a great way for folks to learn about Font Awesome.