Skip to content

Commit

Permalink
docs: update for new icon exports
Browse files Browse the repository at this point in the history
  • Loading branch information
ayuhito committed Apr 28, 2023
1 parent 2bc8617 commit aef1468
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ import {
APIv1,
APIv2,
APIVariable,
APIIconStatic,
APIIconVariable,
APILicense,
APIRegistry,
} from "google-font-metadata";
const {
APIv1,
APIv2,
APIVariable,
APIIconStatic,
APIIconVariable,
APILicense,
APIRegistry,
} = require("google-font-metadata");
Expand Down Expand Up @@ -260,6 +264,8 @@ Exports [`data/licenses.json`](https://github.com/fontsource/google-font-metadat

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

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.

## Updating API Files

You can use the `gfm` CLI tool to update the metadata with fresh results from the Google APIs.
Expand Down Expand Up @@ -295,11 +301,3 @@ Flags:
- `-1, --v1` - Only validate APIv1.
- `-2, --v2` - Only validate APIv2.
- `-v, --variable` - Only validate APIVariable.

##

`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.

## Other Notes

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 comments on commit aef1468

Please sign in to comment.