diff --git a/UPGRADING.md b/UPGRADING.md index 8178472..4b8c443 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,9 +1,24 @@ # Upgrading Versions ## 2.0 to 3.0 -3.0 has updated the default export to be a little more friendly for modern tooling. Anywhere you were previously using -`const fontawesomeSubset = require('fontawesome-subset');` may need to be updated to the newer format, -`import { fontawesomeSubset } from "fontawesome-subset";`. +3.0 has updated the default export to be an object for future upgrades / maintainability. Anywhere you were previously +using a singular import you'll need to update to destructure or pull from the object instead. Example below: + +Old: +```javascript +const fontawesomeSubset = require('fontawesome-subset'); +``` + +New: +```javascript +const { fontawesomeSubset } = require("fontawesome-subset"); +``` + +New (TypeScript / Module Syntax): +```typescript +import { fontawesomeSubset } from "fontawesome-subset"; +``` + ## 1.x to 2.0 Version 2.0 of fontawesome-subset removes the required dependency for `@fortawesome/fontawesome-free`. diff --git a/package-lock.json b/package-lock.json index e09e306..df49940 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "fontawesome-subset", - "version": "3.0.0-beta.1", + "version": "3.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "fontawesome-subset", - "version": "3.0.0-beta.1", + "version": "3.0.0", "license": "GPL-3.0-or-later", "dependencies": { "lodash": ">=4.17.21", diff --git a/package.json b/package.json index 89ca812..9d20acf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "fontawesome-subset", - "version": "3.0.0-beta.1", + "version": "3.0.0", "description": "Utility to create subsets for FontAwesome and FontAwesome Pro.", "main": "dist/index.js", "types": "dist/index.d.ts",