Files
Font-Awesome-Pro/README.md
2018-01-25 15:28:26 -06:00

80 lines
5.8 KiB
Markdown

<h1 align="center"><img src="https://img.fortawesome.com/349cfdf6/gh-logo.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](https://fontawesome.com/get-started) with Font Awesome or dive deeper into [other topics](https://fontawesome.com/how-to-use).
* [SVG with JS](https://fontawesome.com/how-to-use/svg-with-js)
* [Web Fonts with CSS](https://fontawesome.com/how-to-use/web-fonts-with-css)
* [Use on the Desktop](https://fontawesome.com/how-to-use/use-on-desktop)
* [Use with Node.js](https://fontawesome.com/how-to-use/use-with-node-js)
* [JS Component Packages](https://fontawesome.com/how-to-use/js-component-packages)
* [SVG Sprites](https://fontawesome.com/how-to-use/svg-sprites)
* [Upgrading from Version 4](https://fontawesome.com/how-to-use/upgrading-from-4)
* [Server Side Rendering](https://fontawesome.com/how-to-use/server-side-rendering)
* [Font Awesome API](https://fontawesome.com/how-to-use/font-awesome-api)
* [Performance and Security](https://fontawesome.com/how-to-use/performance-and-security)
* [Accessibility](https://fontawesome.com/how-to-use/accessibility)
## 5.0.5 release
Login to your https://fontawesome.com account to download the latest version of Font Awesome Pro.
## Project Progress
Keep track of our progress through this project's [change log](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CHANGELOG.md). Want to keep up with what's planned for Font Awesome Pro? Check out [our milestones](https://github.com/FortAwesome/Font-Awesome-Pro/milestones?direction=asc&sort=due_date&state=open).
## How We'll Work
### Icon Design Workflow
We'll be releasing design concepts for icons as we make progress. Please check the project's [milestones](https://github.com/FortAwesome/Font-Awesome-Pro/milestones?direction=asc&sort=due_date&state=open) for icon design status. Icons will be organized in the following ways:
* Icons will be kept within the [`icons`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory in the repo.
* Font Awesome Free icons will be organized in the [`icons/free`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory
* Font Awesome Pro icons will be organized in the [`icons/pro`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons/free) directory
* Icon category packs will be contained within the `_categories` folder of `free`/`pro` directories.
* Each icon will have a production-ready version (`[icon-name].svg`) created for each of its styles and states.
* We may eventually add preview boards of different icon groups (styles, categories, etc.) for easier browsing/consistency reviews.
* We may share more work in progress files for specific icons as part of pull requests.
We'll use the following tools to design and produce icons:
* Adobe Illustrator
* Inkscribe
* SVGO for optimization
## Contributing
Contributions, in code and constructive feedback, are very welcome. Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CONTRIBUTING.md).
Included are directions for opening issues, coding standards, and community expectations.
## 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.
## Versioning
Font Awesome Pro will be maintained under the [Semantic Versioning guidelines](http://semver.org) as much as possible. Releases will be numbered
with the following format:
`<major>.<minor>.<patch>`
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes, changes to brand logos, and misc changes bumps the patch
## 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.
## Team
[<img src="https://img.fortawesome.com/349cfdf6/dave-pixelated-800.png" alt="" height="100">](https://github.com/davegandy) | [<img src="https://img.fortawesome.com/349cfdf6/travis-pixelated-800.png" alt="" height="100">](https://github.com/supercodepoet) | [<img src="https://img.fortawesome.com/349cfdf6/rob-pixelated-800.png" alt="" height="100">](https://github.com/robmadole) | [<img src="https://img.fortawesome.com/349cfdf6/brian-pixelated-800.png" alt="" height="100">](https://github.com/talbs)
---|---|---|---
[Dave Gandy](https://github.com/davegandy) | [Travis Chase](https://github.com/supercodepoet) | [Rob Madole](https://github.com/robmadole) | [Brian Talbot](https://github.com/talbs)