Skip to content

Commit 3057d14

Browse files
committed
Add icon-families.json usage to README
1 parent 3ff714f commit 3057d14

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ a public github repository or other public file sharing services.
8989
* Go to the location of your custom font_awesome_flutter version (see [setup](#setup))
9090
* Download the web version of font awesome pro and open it
9191
* Move **all** `.ttf` files from the `webfonts` directory and `icons.json` from `metadata` to
92-
`path/to/your/font_awesome_flutter/lib/fonts`. Replace existing files.
92+
`path/to/your/font_awesome_flutter/lib/fonts`. Replace existing files.
93+
Newer versions might have an `icon-families.json`. If this is the case,
94+
move its contents to `path/to/your/font_awesome_flutter/lib/fonts/icons.json`.
9395
* Run the configurator. It should say "Custom icons.json found"
9496

9597
It may be required to run `flutter clean` in apps who use this version for changes to appear.
@@ -112,12 +114,12 @@ As all icons could theoretically be requested, none can be removed by flutter. I
112114
option in conjunction with [a limited set of styles](#excluding-styles) and with as few of them as possible. You may
113115
need to build your app with the `--no-tree-shake-icons` flag for it to succeed.
114116

115-
Using the new configurator tool, this is now an optional feature. Run the tool with the `--dynamic` flag to generate...
117+
Using the configurator tool, this is now an optional feature. Run the tool with the `--dynamic` flag to generate...
116118
```
117119
$ ./configurator.sh --dynamic
118120
```
119-
...and the following import to use the map. For normal icons, use `faIconNameMapping` with a key of this format:
120-
'style icon-name'.
121+
...and use the following import to access the map. For normal icons, use
122+
`faIconNameMapping` with a key of this format: 'style icon-name'.
121123
```dart
122124
import 'package:font_awesome_flutter/name_icon_mapping.dart';
123125

0 commit comments

Comments
 (0)