From 330f3b07871cc30c268a450f48e623e3e08e2a61 Mon Sep 17 00:00:00 2001 From: Tancredi Trugenberger Date: Thu, 12 Apr 2018 23:25:20 +0100 Subject: [PATCH] Add node version and downgrade warning --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2be3fdd..be7a9ba 100644 --- a/README.md +++ b/README.md @@ -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. @@ -42,8 +46,6 @@ Options: --htmlpath HTML output path (Defaults to /.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 /.json) -p, --prefix CSS classname prefix for icons (Default: icon)