Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
docs: update readme
  • Loading branch information
debs-obrien committed Dec 4, 2020
1 parent 76c47f4 commit d7f254f
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![@nuxtjs/google-fonts](./docs/static/preview.svg)](https://google-fonts.nuxtjs.org)

# @nuxtjs/google-fonts

[![npm version][npm-version-src]][npm-version-href]
Expand All @@ -8,7 +10,8 @@

> [Google Fonts](https://developers.google.com/fonts) module for [NuxtJS](https://nuxtjs.org)
[πŸ“– **Release Notes**](./CHANGELOG.md)
- [πŸ“– **Release Notes**](./CHANGELOG.md)
- [πŸ“–  Documentation](https://google-fonts.nuxtjs.org)

## Features

Expand All @@ -22,6 +25,8 @@
- Download css/fonts to local project (No need external resources)
- Encode fonts to base64

[πŸ“–  Read more](https://google-fonts.nuxtjs.org)

## Setup

1. Add `@nuxtjs/google-fonts` dependency to your project
Expand Down Expand Up @@ -61,6 +66,8 @@ export default {

## Options

See [module options](https://google-fonts.nuxtjs.org/options).

### `families`

- Type: `Object`
Expand Down Expand Up @@ -142,6 +149,8 @@ This option inject `<link rel="stylesheet" href="https://fonts.googleapis.com/cs

### `download`

See [downloading Google Fonts](https://google-fonts.nuxtjs.org/downloading)

- Type: `Boolean`
- Default: `false`

Expand Down

0 comments on commit d7f254f

Please sign in to comment.