Skip to content

Commit aef1468

Browse files
committed
docs: update for new icon exports
1 parent 2bc8617 commit aef1468

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,17 @@ import {
2121
APIv1,
2222
APIv2,
2323
APIVariable,
24+
APIIconStatic,
25+
APIIconVariable,
2426
APILicense,
2527
APIRegistry,
2628
} from "google-font-metadata";
2729
const {
2830
APIv1,
2931
APIv2,
3032
APIVariable,
33+
APIIconStatic,
34+
APIIconVariable,
3135
APILicense,
3236
APIRegistry,
3337
} = require("google-font-metadata");
@@ -260,6 +264,8 @@ Exports [`data/licenses.json`](https://github.com/fontsource/google-font-metadat
260264

261265
Exports [`data/licenses.json`](https://github.com/fontsource/google-font-metadata/tree/main/data/axis-registry.json)
262266

267+
You can refer to [`src/index.ts`](https://github.com/fontsource/google-font-metadata/blob/main/src/index.ts) and [`src/data.ts`](https://github.com/fontsource/google-font-metadata/blob/main/src/data.ts) to see all exports.
268+
263269
## Updating API Files
264270

265271
You can use the `gfm` CLI tool to update the metadata with fresh results from the Google APIs.
@@ -295,11 +301,3 @@ Flags:
295301
- `-1, --v1` - Only validate APIv1.
296302
- `-2, --v2` - Only validate APIv2.
297303
- `-v, --variable` - Only validate APIVariable.
298-
299-
##
300-
301-
`npx gfm update-db` - [EXPERIMENTAL] This aims to move parsing away from the client and instead push updates to NPM as new versions, similar to [caniuse-lite](https://github.com/browserslist/caniuse-lite). It will soon be the preferred way to update the metadata as it removes the need to setup Google Credentials and skip the wait-time of long parses.
302-
303-
## Other Notes
304-
305-
Feel free to star and contribute new ideas that aim to improve the repository. Any suggestions or ideas can be voiced via an [issue](https://github.com/fontsource/google-font-metadata/issues).

0 commit comments

Comments
 (0)