README.md

   1 <h1><img src="https://img.fortawesome.com/349cfdf6/logo-fa-free.svg" alt="Font Awesome 5 Free" width="50%"></h1>
   2
   3 > Version 5 – the iconic SVG, font, and CSS framework
   4
   5 The internet's most popular icon toolkit has been redesigned and built from
   6 scratch. On top of this, features like icon font ligatures, an SVG framework,
   7 official NPM packages for popular frontend libraries like React, and access to
   8 a new CDN.
   9
  10 Not familiar with Font Awesome 5? [Learn
  11 more](https://www.kickstarter.com/projects/232193852/font-awesome-5) about our
  12 successful Kickstarter and plan. You can also **[order Font Awesome
  13 Pro](https://fontawesome.com/pro)** which includes tons more icons directly
  14 from [fontawesome.com](https://fontawesome.com).
  15
  16 ## Documentation
  17
  18 Learn how to get started with Font Awesome and then dive deeper into other and advanced topics:
  19
  20 ### Using Font Awesome on the Web
  21
  22 * [With SVG with JavaScript](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=svg-with-js)
  23 * [With web fonts with CSS](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=web-fonts-with-css)
  24 * [Upgrading from version 4](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4)
  25 * [Installing Font Awesome with a package manager](https://fontawesome.com/how-to-use/on-the-web/setup/using-package-managers)
  26 * [Downloading + hosting Font Awesome yourself](https://fontawesome.com/how-to-use/on-the-web/setup/hosting-font-awesome-yourself)
  27 * [Performance and security](https://fontawesome.com/how-to-use/performance-and-security)
  28 * [Accessibility](https://fontawesome.com/how-to-use/on-the-web/other-topics/accessibility)
  29 * [Troubleshooting](https://fontawesome.com/how-to-use/on-the-web/other-topics/troubleshooting)
  30
  31 #### Advanced Options & Techniques
  32
  33 * [Using CSS pseudo-elements](https://fontawesome.com/how-to-use/on-the-web/advanced/css-pseudo-elements)
  34 * [SVG sprites](https://fontawesome.com/how-to-use/svg-sprites)
  35 * [The Font Awesome API](https://fontawesome.com/how-to-use/font-awesome-api)
  36 * [SVG symbols](https://fontawesome.com/how-to-use/on-the-web/advanced/svg-symbols)
  37 * [SVG JavaScript Core](https://fontawesome.com/how-to-use/on-the-web/advanced/svg-javascript-core)
  38 * [Server side rendering](https://fontawesome.com/how-to-use/server-side-rendering)
  39
  40 ### Using Font Awesome on the Desktop
  41
  42 * [Getting started](https://fontawesome.com/how-to-use/on-the-desktop/setup/getting-started)
  43 * [Upgrading from version 4](https://fontawesome.com/how-to-use/on-the-desktop/setup/upgrading-from-version-4)
  44 * [Using ligatures](https://fontawesome.com/how-to-use/on-the-desktop/referencing-icons/using-ligatures)
  45 * [Using glyphs](https://fontawesome.com/how-to-use/on-the-desktop/referencing-icons/using-glyphs)
  46 * [Troubleshooting](https://fontawesome.com/how-to-use/on-the-desktop/other-topics/troubleshooting)
  47
  48 ### Where did Font Awesome 4 (or 3) go?
  49
  50 Now that Font Awesome 5 has been released we are marking version 4 as
  51 end-of-life. We don't plan on releasing any further versions of the 4.x or 3.x.
  52
  53 Documentation is still available but it's moved to
  54 [https://fontawesome.com/v4.7.0](https://fontawesome.com/v4.7.0) and
  55 [https://fontawesome.com/v3.2.1](https://fontawesome.com/v3.2.1).
  56
  57 The Git repository for
  58 [v4.7.0](https://github.com/FortAwesome/Font-Awesome/releases/tag/v4.7.0) and
  59 [v3.2.1](https://github.com/FortAwesome/Font-Awesome/releases/tag/v3.2.1) can
  60 be found in our GitHub releases.
  61
  62 ## Change log
  63
  64 We'll keep track of each release in the [CHANGELOG.md](./CHANGELOG.md)
  65
  66 Looking for older versions of Font Awesome? Check the [releases](https://github.com/FortAwesome/Font-Awesome/releases).
  67
  68 ## Upgrading
  69
  70 From time-to-time we'll have special upgrading instructions from one version to the next.
  71
  72 Check out the [UPGRADING.md](./UPGRADING.md) guide when you upgrade your dependencies.
  73
  74 ## Code of conduct
  75
  76 We will behave ourselves if you behave yourselves. For more details see our
  77 [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
  78
  79 ## Contributing
  80
  81 Please read through our [contributing guidelines](./CONTRIBUTING.md).  Included
  82 are directions for opening issues.
  83
  84 ## Versioning
  85
  86 Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
  87 with the following format:
  88
  89 `<major>.<minor>.<patch>`
  90
  91 For more information on SemVer, please visit http://semver.org.
  92
  93 **The major version "5" is part of an umbrella release.  It includes many different types of files and technologies. Therefore
  94 we deviate from normal SemVer in the following ways:**
  95
  96 * Any release may update the design, look-and-feel, or branding of an existing
  97   icon
  98 * We will never intentionally release a `patch` version update that breaks
  99   backward compatibility
 100 * A `minor` release **may include backward-incompatible changes** but we will
 101   write clear upgrading instructions in UPGRADING.md
 102 * A `minor` or `patch` release will never remove icons
 103 * Bug fixes will be addressed as `patch` releases unless they include backward
 104   incompatibility then they will be `minor` releases
 105
 106 ## License
 107
 108 Font Awesome Free is free, open source, and GPL friendly. You can use it for
 109 commercial projects, open source projects, or really almost whatever you want.
 110
 111 - Icons — CC BY 4.0 License
 112   - In the Font Awesome Free download, the CC BY 4.0 license applies to all icons packaged as .svg and .js files types.
 113 - Fonts — SIL OFL 1.1 License
 114   - In the Font Awesome Free download, the SIL OLF license applies to all icons packaged as web and desktop font files.
 115 - Code — MIT License
 116   - In the Font Awesome Free download, the MIT license applies to all non-font and non-icon files.
 117
 118 Attribution is required by MIT, SIL OLF, and CC BY licenses. Downloaded Font
 119 Awesome Free files already contain embedded comments with sufficient
 120 attribution, so you shouldn't need to do anything additional when using these
 121 files normally.
 122
 123 We've kept attribution comments terse, so we ask that you do not actively work
 124 to remove them from files, especially code. They're a great way for folks to
 125 learn about Font Awesome.
 126
 127 ## Team
 128
 129 * [Dave Gandy](https://github.com/davegandy)
 130 * [Travis Chase](https://github.com/supercodepoet)
 131 * [Rob Madole](https://github.com/robmadole)
 132 * [Brian Talbot](https://github.com/talbs)
 133 * [Jory Raphael](https://github.com/sensibleworld)
 134 * [Mike Wilkerson](https://github.com/mlwilkerson)
 135 * [Geremia Taglialatela](https://github.com/tagliala)