# node-freetype2

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/julusian/node-freetype2/node.yaml?branch=main)
[![npm](https://img.shields.io/npm/v/@julusian/freetype2.svg)](https://www.npmjs.com/package/@julusian/freetype2)
[![npm](https://img.shields.io/npm/dm/@julusian/freetype2.svg)](https://www.npmjs.com/package/@julusian/freetype2)
[![npm](https://img.shields.io/npm/l/@julusian/freetype2.svg)](LICENSE)

FreeType bindings for Nodejs. This library is written to be as close to the original api as possible, but in a safer and more node-like manner.

FreeType is a freely available software library to render fonts. http://www.freetype.org/

## Install

`npm install @julusian/freetype2`


## Examples
See the [example folder](https://github.com/julusian/node-freetype2/tree/master/example) to learn how to use node-freetype2.

## API
See the [types](https://github.com/julusian/node-freetype2/blob/master/module.d.ts) to learn the API of node-freetype2 and how they relate to original FreeType.

For more information, see the [original FreeType documentation](http://www.freetype.org/freetype2/docs/reference/ft2-index.html).