Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
protodave committed Jan 20, 2015
1 parent 5baf8c9 commit 48d8818
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

**A toolkit for working with, styling and converting SVG files.**

SVG Toolkit helps you work with SVG input files by normalizing, colorizing, styling and optionally converting to other formats, ready for production use.
SVG Toolkit helps you work with SVG files by normalizing, colorizing, styling and optionally converting them to other formats, ready for production use.

Example uses:
A few example uses:

* Create colorized SVGs and PNGs across an entire SVG icon set. Colors of your design changed? No problem... update your grunt file and re-run. Done. No need to open your design tools and update and re-export all your assets.
* Create colorized SVGs and PNGs across an entire SVG icon set. Colors in your design changing? No problem... update your grunt file and re-run. Done. No need to open your design tools to update and re-export all your assets.

* Using a CSS file to generate customized, themed SVG and PNG output assets.
* Use a CSS file to generate customized, themed SVG and PNG output assets.

* Basic (and conservative) SVG markup cleanup and normalization, decreasing asset size and increasing performance.
* SVG markup cleanup and normalization, decreasing asset size and increasing performance.

Vector workflow powerup Pro-Tip:
Vector workflow powerup ProTip:

> SVG Toolkit works great with the output generated from the [Illustrator SVG Exporter](https://github.com/iconic/illustrator-svg-exporter)!
> SVG Toolkit works great with the output generated from our [Illustrator SVG Exporter](https://github.com/iconic/illustrator-svg-exporter)!
## Getting Started
This plugin requires Grunt `~0.4.0`
Expand Down Expand Up @@ -75,15 +75,15 @@ Should PNGs be generated.
Type: `String`
Default: undefined

The location of a CSS file that should be applied to the SVG(s). Great for creating a theme across an icon set and generating a matching set of SVGs/PNGs.
The location of a CSS file that should be applied to the SVG files. Great for creating a theme across an icon set and generating a matching set of SVGs/PNGs.

##### colorize
Type: `String`
Default: undefined

Define a hex color value (e.g. #d8dfd8) or HTML color name (e.g. thistle) to colorize the SVG(s) by setting their `stroke` and `fill` attributes. Great for colorizing a set of icons.
Define a hex color value (e.g. #d8dfd8) or HTML color name (e.g. thistle) to colorize the SVG files by setting their `stroke` and `fill` attributes. Great for colorizing a set of icons.

> Note: The `colorize` setting will override the `style` setting.
> Note: The `colorize` setting, if set, will override the `style` setting.
##### debug
Type: `Boolean`
Expand All @@ -94,7 +94,7 @@ Log task progress and details about the processing of each SVG.

## Known Issues

* SVG files with external font imports don't generate PNGs using those fonts currently. This will supposedly work in the upcoming PhantomJS 2 which has better font handling. Reference: https://github.com/ariya/phantomjs/issues/10592
* SVG files with external font imports don't generate PNGs using those fonts currently. This will supposedly work in the upcoming [PhantomJS 2](https://github.com/ariya/phantomjs/wiki/PhantomJS-2), which has better font handling. Reference: https://github.com/ariya/phantomjs/issues/10592

```
<defs>
Expand All @@ -110,10 +110,14 @@ Your feedback is most welcome.

Have a troublesome SVG you are using that isn't generating the output you'd expect? Open an [issue](https://github.com/iconic/grunt-svg-toolkit/issues) with the details and include the SVG markup for us to test with.

Have an awesome idea for a new feature or additional output format that would be useful? Create a [`feature request` labeled issue](https://github.com/iconic/grunt-svg-toolkit/labels/feature%20request) describing it, or even better... send a [pull request](https://github.com/iconic/grunt-svg-toolkit/pulls)!
Have an awesome idea for a new feature or additional output format that would be useful? Create a [`feature request` issue](https://github.com/iconic/grunt-svg-toolkit/labels/feature%20request) describing it, or even better... send a [pull request](https://github.com/iconic/grunt-svg-toolkit/pulls)!

Bugs? You know what to [do](https://github.com/iconic/grunt-svg-toolkit/issues).

## Background

This project is the result of abstracting and generalizing the icon production process tools used in building [Iconic](https://useiconic.com/), and to open source those pieces that might be more widely useful and applicable to the design and development communities.

## Release History

### v0.1.0 (01/20/2015)
Expand Down

0 comments on commit 48d8818

Please sign in to comment.