Skip to content

Commit

Permalink
Readme Update and some finalizing
Browse files Browse the repository at this point in the history
  • Loading branch information
erikyo committed Sep 12, 2017
1 parent cee2ab8 commit 67d162a
Show file tree
Hide file tree
Showing 5 changed files with 853 additions and 1,915 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ Configuration is very fast ... in the $icon-list array you have to enter some pa

All svg icons are merged into a single css sheet and this allows for a very lightweight file: **~600 icon gzipped size is only 16.8kb! less than one 256x256 png icon.**

* * *
## INSTALLATION

git clone https://github.com/erikyo/mime-icon-generator.git && cd mime-icon-generator && npm install

**gulp watch** - sass watch (witj sourcemap and autoprefixer)

**gulp finalize** - (default) like gulp watch but the generated files are moved to the dist folder. a gzipped version of the minified one is also created)

* * *

## USAGE
Expand Down Expand Up @@ -45,5 +54,5 @@ You can recall your newly generated icon whit this code
* The **second** argument is optional: if it is not passed (or is not a color) will be used a color from the array called $icon-colors https://github.com/erikyo/mime-icon-generator/blob/master/scss/generator-colors.scss
* The **third** argument is the icon ascii. You can pass one of the variables of "scss/generator-vars.scss" https://github.com/erikyo/mime-icon-generator/blob/master/scss/generator-vars.scss. Remember to load the font fonts you like and edit this set of variables that will be very convenient to you

#### Utilities - google sheet docs
#### Utilities - google sheet docs (can be useful to mass generate your icons)
https://docs.google.com/spreadsheets/d/15Xg_7qReclvRpHDXnVL2go9T-QntLAZJj58KdY4YURU/edit?usp=sharing
Loading

0 comments on commit 67d162a

Please sign in to comment.