bj93 / font-awesome-wordpress-plugin

Font Awesome (http://fortawesome.github.com/Font-Awesome) Icons for use in WordPress.

#Font Awesome Icons

Contributors: rachelbaker

Tags: icons, font-awesome, font icon, UI, icon font, bootstrap

Requires at least: 3.0

Tested up to: 3.5

Stable tag: 3.0

License: GPLv3 or later

License URI: http://www.gnu.org/licenses/gpl-3.0.html

Enables easy use of the Font Awesome icon font set from within WordPress. Icons can be inserted using either HTML or a shortcode.

Font Awesome is a pictographic font set of 249 icons. The icons are infinitely scalable and screen reader compatible.

A full list of the 249 Font Awesome icons is available: http://fortawesome.github.com/Font-Awesome/#all-icons

##Usage Instructions

To use any of the Font Awesome icons on your WordPress site you have two options:

HTML Option

All code examples on the Font Awesome site apply: http://fortawesome.github.com/Font-Awesome/#code

Examples

Pencil icon

<i class="icon-pencil"></i>

Phone icon

<i class="icon-phone"></i>

Chevron left icon

<i class="icon-chevron-left"></i>

Shortcode Option

Don't want to worry about HTML tags? You can use a shortcode in your posts, pages and even widgets to display a Font Awesome icon.

The shortcode to use is [icon name=name-of-icon], where name=X is the class of the icon you would like to use.

Pencil icon

[icon name=icon-pencil]

Phone icon

[icon name=icon-phone]

Chevron left icon

[icon name=icon-chevron-left]

##Installation

1. Upload Font Awesome Icons to the /wp-content/plugins/ directory.

2. Activate the plugin through the 'Plugins' menu in WordPress.

3. Add shortcode to your posts, pages and even widgets to display a Font Awesome icon.

The shortcode to use is [icon name=name-of-icon], where name=X is the class of the icon you would like to use.

##Release Notes

Version 3.0

Updated font and CSS files to Font Awesome 3.0 release.

Version 1.2

Added IE7 conditional stylesheet

Version 1.1

Created and enabled shortcode

Version 1.0

Initial release

Upcoming Versions Wishlist

• Add TinyMCE button to allow easy insertation of Font Awesome icon

##Author

• Rachel Baker

##Credits

Font Awesome webfont and associated code are licensed under CC BY 3.0 and is a production of @fortaweso_me, by Dave Gandy.

##License License: Copyright (C) 2012 Rachel Baker, Plugged In Consulting, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.