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

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrianoCahete committed Jun 18, 2019
1 parent 5475cb6 commit 797c486
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
![Icon](https://camo.githubusercontent.com/2b418776b6cc9cb7d90c68905d3381674f13d7ec/687474703a2f2f692e6375626575706c6f61642e636f6d2f4541367957612e706e67)

## Icon font generator
## Webfont Generator CLI

![Screenshot](https://camo.githubusercontent.com/7aaef96033be671fa29297c0efd6c50f97a502f6/68747470733a2f2f692e6375626575706c6f61642e636f6d2f65597736766a2e706e67)

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

Forked from [@Workshape/icon-font-generator](https://github.com/Workshape/icon-font-generator)
> 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..
Expand Down Expand Up @@ -57,9 +56,13 @@ Options:
--mono Make font monospace (Default: false)
--height Fixed font height value
--center Center font horizontally
--timestamp Override font creation time (Unix time stamp)
--codepoint The starting character code to count up from (Optional)
--codepoints Path to explicit character code mapping JSON file (Optional)
```


### License

Copyright (c) 2019 Adriano Cahete - Released under the [MIT license](https://github.com/AdrianoCahete/webfont-generator-cli/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)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "webfont-generator-cli",
"version": "2.1.13",
"version": "2.2.0",
"description": "Easy-to-use, pre-configured cli tool to generate webfont icon kits from a bunch of .svg files",
"main": "index.js",
"repository": {
Expand Down

0 comments on commit 797c486

Please sign in to comment.