Skip to content

Commit

Permalink
Add Changelog, Update package.json & readme
Browse files Browse the repository at this point in the history
- Add changelog
- Update package.json with new version - switch to semver
- Update Readme with new duotone information
  • Loading branch information
omacranger committed Nov 13, 2019
1 parent f5efb38 commit 29a1aba
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 4 deletions.
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.1.0](https://github.com/omacranger/fontawesome-subset/releases/tag/1.1.0)

### Added
- Ability to generate optimized [Duotone](https://fontawesome.com/how-to-use/on-the-web/styling/duotone-icons) icons by supplying the `duotone` key to the subset option. See readme for full usage details.

### Fixed
- Resolved issue with `.eot` / `.woff` file generation for IE / older browsers.

## [1.0.0](https://github.com/omacranger/fontawesome-subset/releases/tag/1.0.0)

Initial release on Github and version which was published to NPM as 0.1.0. Updated to semver.

### Added
- Ability to generate subsets for FontAwesome based on a supplied list of icon / glyph names
- Includes support for FontAwesome Pro & Free versions
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FontAwesome Subset

Love FontAwesome but don't need 1800 icons bundled on every page of the site? Me either. `fontawesome-subset` is a utility for creating subsets of FontAwesome for optimized use on the web. It works by taking glyph names that you've used (`angle-left`, `caret-up`, etc) and creating an optimized font with only the glyphs you need. Yes, SVG icons and fragments are fancier and more feature filled - but if you already have a website built using the webfont - why switch -- right?
Love FontAwesome but don't need thousands of icons bundled on every page of the site? Me either. `fontawesome-subset` is a utility for creating subsets of FontAwesome for optimized use on the web. It works by taking glyph names that you've used (`angle-left`, `caret-up`, etc) and creating an optimized font with only the glyphs you need. Yes, SVG icons and fragments are fancier and more feature filled - but if you already have a website built using the webfont - why switch -- right?

## Usage
Install:
Expand All @@ -18,7 +18,7 @@ fontawesomeSubset(['check','square','caret-up'], 'sass/webfonts');
### Full Options

#### fontawesomeSubset(subset, output_dir, options)
- `subset` - Array containing list of glyph names (icon names) that you want to limit the subset to. When using FontAwesome Pro (see [below](#using-with-fontawesome-pro)) you can supply an object with key->value pairs for different FA styles (solid, regular, light, brands).
- `subset` - Array containing list of glyph names (icon names) that you want to limit the subset to. When using FontAwesome Pro (see [below](#using-with-fontawesome-pro)) you can supply an object with key->value pairs for different FA styles (solid, regular, light, brands, duotone).
- `output_dir` - Directory that you want the webfonts to be generated in. Relative to current NPM process. Ex: `sass/webfonts`
- `options` - Object of options to further customize the tool.
- `package` - `free` or `pro` . Defaults to `free` version. See [below](#using-with-fontawesome-pro) for Pro instructions.
Expand All @@ -41,7 +41,7 @@ fontawesomeSubset({
});
```

You can use any of the weights provided by FontAwesome Pro including `solid`, `regular`, `light`, or `brands`. You can mix and match and provide as many glyphs as you plan on using to trim it down.
You can use any of the weights / sets provided by FontAwesome Pro including `solid`, `regular`, `light`, `brands`, or `duotone`. You can mix and match and provide as many glyphs as you plan on using to trim it down.

The above example would output a directory with the following structure:
```
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fontawesome-subset",
"version": "0.1.0",
"version": "1.1.0",
"description": "Utility to create subsets for FontAwesome and FontAwesome Pro.",
"main": "index.js",
"scripts": {
Expand Down Expand Up @@ -33,6 +33,7 @@
"fontawesome",
"fontawesome pro",
"subset",
"subsetter",
"icon font",
"optimize"
]
Expand Down

0 comments on commit 29a1aba

Please sign in to comment.