Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions .github/workflows/publish.yml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:

strategy:
matrix:
node-version: [14.x, 16.x, 18.x]
node-version: [14.x, 16.x, 18.x, 20.x, 22.x, 24.x]

steps:
- uses: actions/checkout@v2
Expand Down
74 changes: 0 additions & 74 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,76 +1,2 @@
# -- Node.js --

# Logs
logs
*.log
npm-debug.log*

# Dependency directory
/node_modules

# Optional npm cache directory
.npm


# -- VSCode --
/.vscode
jsconfig.json


# -- IDEA --
/.idea

## File-based project format:
*.ipr
*.iws
*.iml


# -- Vim --

# swap
[._]*.s[a-w][a-z]
[._]s[a-w][a-z]

# session
Session.vim

# temporary
.netrwhist
*~
/tmp


# -- Eclipse --
*.swp


# -- OS X --
.DS_Store


# -- Public --
/public
/public-sandbox


# -- Tests --
/test-reports
/test-logs
/gemini-*
/screenshots


# -- Sass --
.sass-cache


# -- ESLint --
.eslintcache

# -- Stylelint --
.stylelintcache


# -- Dist --
dist
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## 4.0.0 (25.12.2025)

Ensured Node.js 20, 22 & 24 support.

Moved package from @funboxteam to @necrobox scope.


## 3.0.1 (20.06.2023)

Fixed the way Beatrix works with file paths, just to be sure that it won't blow up the directories outside of its domain.
Expand Down
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,9 @@

<div align="center">
<b>Beatrix</b> chops off useless fonts parts and converts TTF/OTF files into WOFF & WOFF2
</div>

## Rationale

Users spend a lot of time downloading web assets: JS, CSS, images, fonts, etc.
To reduce waiting time, developers compress the assets, gzip them, use optimized formats for images and fonts.

But sometimes the developers can go a little bit further. When they have all the rights for fonts they use,
it's possible to leave only the glyphs their website needs. Just cut off the rest ones.

That's exactly how the tool works.
</div>

## Getting Started
## Getting started

[По-русски](./README.ru.md)

Expand All @@ -30,7 +20,7 @@ pip install fonttools zopfli brotli
Then you can install Beatrix:

```sh
npm install --save @funboxteam/beatrix
npm install --save @necrobox/beatrix
```

Now you're ready to optimize your fonts.
Expand Down Expand Up @@ -165,4 +155,12 @@ The characters and features described above will be left in the font files, all

If you want to remove all the characters or features completely just pass an empty array.

[![Sponsored by FunBox](logo-bottom.svg)](https://funbox.ru)
## Rationale

Users spend a lot of time downloading web assets: JS, CSS, images, fonts, etc.
To reduce waiting time, developers compress the assets, gzip them, use optimized formats for images and fonts.

But sometimes the developers can go a little bit further. When they have all the rights for fonts they use,
it's possible to leave only the glyphs their website needs. Just cut off the rest ones.

That's exactly how the tool works.
24 changes: 11 additions & 13 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,9 @@
</div>

<div align="center">
<b>Beatrix</b> отрезает ненужные части шрифтов и конвертирует TTF/OTF в WOFF и WOFF2
<b>Беатрикс</b> отрезает ненужные части шрифтов и конвертирует TTF/OTF в WOFF и WOFF2
</div>

## Мотивация

Пользователи тратят огромное количество времени на скачивание веб-ассетов: JS, CSS, изображения, шрифты и так далее.
Чтобы как-то уменьшить это время, разработчики сжимают ассеты, гзипают их, используют оптимизированные форматы для картинок и шрифтов.

Но иногда разработчики могут пойти ещё чуть дальше. Если у них есть права на используемые шрифты,
то они могут оставить только те глифы, которые нужны на их сайтах. А остальные можно и вырезать.

Беатрикс как раз для этого и нужна.

## Установка

Беатрикс — это обёртка вокруг Пайтон-скриптов из набора [fonttools](https://github.com/fonttools/fonttools).
Expand All @@ -28,7 +18,7 @@ pip install fonttools zopfli brotli
А затем саму Беатрикс:

```sh
npm install --save @funboxteam/beatrix
npm install --save @necrobox/beatrix
```

Готово.
Expand Down Expand Up @@ -153,4 +143,12 @@ module.exports = {

Символы, описанные выше, будут оставлены в шрифтовых файлах (как и кернинговые пары для них), а остальные будут вырезаны.

[![Sponsored by FunBox](logo-bottom.svg)](https://funbox.ru)
## Мотивация

Пользователи тратят огромное количество времени на скачивание веб-ассетов: JS, CSS, изображения, шрифты и так далее.
Чтобы как-то уменьшить это время, разработчики сжимают ассеты, гзипают их, используют оптимизированные форматы для картинок и шрифтов.

Но иногда разработчики могут пойти ещё чуть дальше. Если у них есть права на используемые шрифты,
то они могут оставить только те глифы, которые нужны на их сайтах. А остальные можно и вырезать.

Беатрикс как раз для этого и нужна.
17 changes: 0 additions & 17 deletions logo-bottom.svg

This file was deleted.

Loading