Skip to content

Commit

Permalink
docs(changelog): Release 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jantimon committed Sep 14, 2016
1 parent ccbf05e commit 7196819
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 20 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
<a name="0.0.3"></a>
## [0.0.3](https://github.com/jantimon/iconfont-webpack-plugin/compare/v0.0.2...v0.0.3) (2016-09-14)


### Bug Fixes

* **postcss-plugin:** Fix dependency watching ([ccbf05e](https://github.com/jantimon/iconfont-webpack-plugin/commit/ccbf05e))


<a name="0.0.2"></a>
## [0.0.2](https://github.com/jantimon/iconfont-webpack-plugin/compare/v0.0.1...v0.0.2) (2016-09-13)

Expand Down
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This release is rather for feedback purpose than for production usage.

# Icon Font Webpack Plugin

This plugin tries to keep the usage and maintainance of icon fonts as simple as possible.
This plugin tries to keep the usage and maintenance of icon fonts as simple as possible.

## Installation

Expand All @@ -15,8 +15,6 @@ npm i --save-dev iconfont-webpack-plugin
## Configuration

```js
var path = require('path');

var IconfontWebpackPlugin = require('iconfont-webpack-plugin');

// make sure you use the postcss loader:
Expand All @@ -32,13 +30,12 @@ var IconfontWebpackPlugin = require('iconfont-webpack-plugin');
plugins: [
new IconfontWebpackPlugin()
]

```

## Usage

If you set this plugin up properly you can finely use a `font-icon` declarations
in your `css/scss/sass/less/...`:
After setting up the plugin your css has now a new feature:
`font-icon` declarations

```css
a:before {
Expand Down Expand Up @@ -70,25 +67,27 @@ a:hover:before {
}
```

## Why shouldn't I just use SVGs instead?
## Should you use icon fonts for everything?

SVGs have some disadvantages and lack certain features especially when using inside pseudo elements.
No.

* [CSS-Transform issues in older Internet Explorer versions](http://stackoverflow.com/questions/21298338/css-transform-on-svg-elements-ie9)
* [IE9 - IE 10 scaling issues](https://gist.github.com/larrybotha/7881691)
* Fill color doesn't work on background SVG images
* Inline SVGs are resolved relative to the page not to the css
Icon fonts are really good for decorative icons (where the icon is purely ornamental and doesn’t incorporate core meaning or functionality).

## Should I use icon fonts for everything?
For critical icons without fallbacks (like a hamburger menu icon) you should rather use SVGs.
But also JPEGs, PNGs and even GIFs have their use cases.

No.
Pick the best solution for your problem - there is no silver bullet.
With this plugin it is pretty easy to use pixel images, svgs and font-icons side by side.

Icon fonts are really good for decorative icons (where the icon is purely ornamental and doesn’t incorporate core meaning or functionality).
## When should you use icon fonts over pure SVGs?

For critical icons without fallbacks (like a hamburger menu icon) you should rather use SVGs.
But also JPEGs, PNGs or even GIFs have their use cases.
Icon fonts are dead - long live font icons.
SVGs have some disadvantages and lack certain features especially when used inside pseudo elements:

Pick the best solution for your problem - there is no silver bullet.
* [CSS-Transform issues in older Internet Explorer versions](http://stackoverflow.com/questions/21298338/css-transform-on-svg-elements-ie9)
* [IE9 - IE 11 scaling issues](https://gist.github.com/larrybotha/7881691)
* Fill color doesn't work for background SVG images
* Inline SVGs are resolved relative to the page not to the css

# License

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "iconfont-webpack-plugin",
"version": "0.0.2",
"description": "Simple icon font handling using webpack",
"version": "0.0.3",
"description": "Simple icon font handling for webpack",
"main": "index.js",
"files": [
"index.js",
Expand Down Expand Up @@ -33,6 +33,7 @@
"ignore": []
},
"devDependencies": {
"conventional-changelog-cli": "^1.2.0",
"css-loader": "^0.23.1",
"cz-conventional-changelog": "^1.2.0",
"extract-text-webpack-plugin": "^1.0.1",
Expand Down

0 comments on commit 7196819

Please sign in to comment.