Skip to content
This repository has been archived by the owner on Dec 22, 2022. It is now read-only.

Commit

Permalink
Update naming
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrianoCahete committed Jun 18, 2019
1 parent 3f68eb2 commit 766fe60
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 166 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,30 @@
### Intro

Forked from [@Workshape/icon-font-generator](https://github.com/Workshape/icon-font-generator)
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.

It also does a couple extra things such as creating a .json file containing the icons to unicode characters map, which may be later used in styles, templates, etc..

#### Upgrading from v1.x.x

**!!** If you're upgrading from `v1.x.x` to `v2.x.x` - here's the changelog and thoubleshooting: https://github.com/Workshape/icon-font-generator/releases/tag/v2.1.2

**!!** `icon-font-generator` `v2.x.x >=` 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)


### Install

```
npm install -g icon-font-generator
npm install AdrianoCahete/webfont-generator-cli
```

### Use

##### Quick usage

```
icon-font-generator my-icons/*.svg -o icon-dist
webfont-generator-cli my-icons/*.svg -o icon-dist
```

##### Cli params

```
Usage : icon-font-generator [ svg-icons-glob ] -o [ output-dir ] [ options ]
Example : icon-font-generator src/*.svg -o dist
Usage : webfont-generator-cli [ svg-icons-glob ] -o [ output-dir ] [ options ]
Example : webfont-generator-cli src/*.svg -o dist
Options:
-o, --out Output icon font set files to <out> directory
Expand Down Expand Up @@ -68,4 +62,4 @@ Options:

### License

Copyright (c) 2014 Workshape.io Ltd. - Released under the [MIT license](https://github.com/Workshape/icon-font-generator/blob/master/LICENSE)
Original Copyright (c) 2014 Workshape.io Ltd. - Released under the [MIT license](https://github.com/Workshape/icon-font-generator/blob/master/LICENSE)
152 changes: 0 additions & 152 deletions bin/icon-font-generator

This file was deleted.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "webfont-generator-cli",
"version": "2.1.12",
"version": "2.1.13",
"description": "Easy-to-use, pre-configured cli tool to generate webfont icon kits from a bunch of .svg files",
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/AdrianoCahete/webfont-generator-cli.git"
},
"bin": {
"webfont-generator-cli": "bin/icon-font-generator"
"webfont-generator-cli": "bin/webfont-generator-cli"
},
"scripts": {},
"author": "Tancredi Trugenberger, Adriano Cahete",
Expand Down

0 comments on commit 766fe60

Please sign in to comment.