Skip to content

Commit

Permalink
Add node version and downgrade warning
Browse files Browse the repository at this point in the history
  • Loading branch information
tancredi committed Apr 12, 2018
1 parent 6ee0d9a commit 330f3b0
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

> Easy-to-use, pre-configured cli tool to generate webfont icon kits from a bunch of .svg files
### Requirements

`icon-font-generator` requires Node.js `>= v8.1.0` - is you wish to run on a lower version, use [v1.1.2](https://github.com/Workshape/icon-font-generator/releases/tag/v1.1.2)

### Intro

This cli utility is ment to make webfont icon sets creation from the command line really simple - It wraps and pre-configures [webfonts-generator](https://www.npmjs.com/package/webfonts-generator), but allows for some degree of customisation.
Expand Down Expand Up @@ -42,8 +46,6 @@ Options:
--htmlpath HTML output path (Defaults to <out>/<name>.html)
--types Font types - (Defaults to 'svg, ttf, woff, woff2, eot')
--htmltp HTML handlebars template path (Optional)
--codepoint The starting character code (Optional)
--codepoints Path to character code JSON map file (Optional)
-j, --json Generate JSON map file if true (Default: true)
--jsonpath JSON output path (Defaults to <out>/<name>.json)
-p, --prefix CSS classname prefix for icons (Default: icon)
Expand Down

0 comments on commit 330f3b0

Please sign in to comment.