Skip to content

Commit b7d4e88

Browse files
chore: update readme and changelog
1 parent 07b6e11 commit b7d4e88

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

CHANGELOG.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,32 @@ All notable changes to this project will be documented in this file. See [standa
44

55
## [1.0.0-beta.1](https://github.com/cssninjaStudio/unplugin-fonts/compare/v1.0.0-beta.0...v1.0.0-beta.1) (2023-03-20)
66

7-
## [1.0.0-beta.0](https://github.com/stafyniaksacha/unplugin-fonts/compare/v0.7.0...v1.0.0-beta.0) (2023-03-19)
7+
## [1.0.0-beta.0](https://github.com/cssninjaStudio/unplugin-fonts/compare/v0.7.0...v1.0.0-beta.0) (2023-03-19)
88

99

1010
### ⚠ BREAKING CHANGES
1111

12-
* - rename virtual "virtual:fonts.css" to "unfonts.css"
12+
- rename virtual "virtual:fonts.css" to "unfonts.css"
1313
- rename package "vite-plugin-fonts" to "unplugin-fonts"
1414

1515
### Features
1616

17-
* add astro component ([a31f167](https://github.com/stafyniaksacha/unplugin-fonts/commit/a31f16765e685cdcc37960f001d0ef1822b22e75))
18-
* add custom font transformer ([05e339a](https://github.com/stafyniaksacha/unplugin-fonts/commit/05e339aa026e469d01a14a2334c3cb1bda2ac432))
19-
* add fontsource font provider ([9cfa836](https://github.com/stafyniaksacha/unplugin-fonts/commit/9cfa8362d253053488c07bd10f4b323d682370b5))
20-
* add fontsource provider ([e62f9c7](https://github.com/stafyniaksacha/unplugin-fonts/commit/e62f9c76e6a21b7957a3c22497496e1d79971904))
21-
* add vitepress and sveltkit examples ([959914e](https://github.com/stafyniaksacha/unplugin-fonts/commit/959914e6beb36af9d82ac8b50a654fb02c0c8960))
22-
* expose typescript declaration ([f3f2276](https://github.com/stafyniaksacha/unplugin-fonts/commit/f3f22766e9a95dd9c1518b329aeaa1c217e515dd))
23-
* migrate plugin to unplugin ([5ae235a](https://github.com/stafyniaksacha/unplugin-fonts/commit/5ae235ac8db5b571634961c8ac85d1a5d6d333b7))
17+
* add astro component ([a31f167](https://github.com/cssninjaStudio/unplugin-fonts/commit/a31f16765e685cdcc37960f001d0ef1822b22e75))
18+
* add custom font transformer ([05e339a](https://github.com/cssninjaStudio/unplugin-fonts/commit/05e339aa026e469d01a14a2334c3cb1bda2ac432))
19+
* add fontsource font provider ([9cfa836](https://github.com/cssninjaStudio/unplugin-fonts/commit/9cfa8362d253053488c07bd10f4b323d682370b5))
20+
* add fontsource provider ([e62f9c7](https://github.com/cssninjaStudio/unplugin-fonts/commit/e62f9c76e6a21b7957a3c22497496e1d79971904))
21+
* add vitepress and sveltkit examples ([959914e](https://github.com/cssninjaStudio/unplugin-fonts/commit/959914e6beb36af9d82ac8b50a654fb02c0c8960))
22+
* expose typescript declaration ([f3f2276](https://github.com/cssninjaStudio/unplugin-fonts/commit/f3f22766e9a95dd9c1518b329aeaa1c217e515dd))
23+
* migrate plugin to unplugin ([5ae235a](https://github.com/cssninjaStudio/unplugin-fonts/commit/5ae235ac8db5b571634961c8ac85d1a5d6d333b7))
2424

2525

2626
### Bug Fixes
2727

28-
* allow loading unfont.css with query ([9006d78](https://github.com/stafyniaksacha/unplugin-fonts/commit/9006d7820607adf96de1c14ad842c234ad6eb9f7))
28+
* allow loading unfont.css with query ([9006d78](https://github.com/cssninjaStudio/unplugin-fonts/commit/9006d7820607adf96de1c14ad842c234ad6eb9f7))
2929

30-
## [0.7.0](https://github.com/stafyniaksacha/unplugin-fonts/compare/v0.6.0...v0.7.0) (2022-12-09)
30+
## [0.7.0](https://github.com/cssninjaStudio/unplugin-fonts/compare/v0.6.0...v0.7.0) (2022-12-09)
3131

3232

3333
### Features
3434

35-
* add vite 4 to peer dependencies version ([60bae97](https://github.com/stafyniaksacha/unplugin-fonts/commit/60bae97fcad268c73009c9950f07ce05ed50b785))
35+
* add vite 4 to peer dependencies version ([60bae97](https://github.com/cssninjaStudio/unplugin-fonts/commit/60bae97fcad268c73009c9950f07ce05ed50b785))

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# unplugin-fonts
22

3-
㊗️ Universal Webfont loader
3+
㊗️ Universal Webfont loader - Unfonts
44

55
[![npm](https://img.shields.io/npm/v/unplugin-fonts.svg)](https://www.npmjs.com/package/unplugin-fonts)
66

7-
Load fonts from any provider and use them in your project, whatever the framework you use.
7+
This plugin goes beyond just generating font-face rules - it also takes care of link preload and prefetch, optimizing font loading for a faster and more efficient user experience.
88

9-
This module takes care of loading the font files and generating the font-face rules. By default it preloads the font files and uses the swap strategy, but you can customize this behavior.
9+
Unfonts currently supports popular font providers like Typekit, Google Fonts, and Fontsource, as well as custom fonts. This gives you the flexibility to choose from a vast range of fonts and seamlessly integrate them into your projects.
1010

11-
Currently supported providers:
11+
With Unfonts, you no longer have to manually manage font files and font-face rules, or worry about slow loading times. Our package does all the heavy lifting for you, so you can focus on creating amazing content with ease.
12+
13+
View configuration:
1214
- [Typekit](#typekit)
1315
- [Google Fonts](#google-fonts)
1416
- [Custom Fonts](#custom-fonts)
@@ -453,6 +455,13 @@ Unfonts({
453455
}
454456
```
455457

458+
or
459+
460+
```ts
461+
// declaration.d.ts
462+
/// <reference types="unplugin-fonts/client" />
463+
```
464+
456465
## Ressources
457466

458467
- https://web.dev/optimize-webfont-loading/

0 commit comments

Comments
 (0)