npm-font-caviar-dreams/README.md

Caviar Dreams font family - including CSS, SCSS, STY and LESS

[![github tag][github-tag-image]][github-tag-url]
[![npm version][npm-version-image]][npm-version-url]
[![npm downloads][npm-downloads-image]][npm-downloads-url]

***

# Caviar Dreams

Presenting the Caviar Dreams TrueType™ Font Family by Lauren Thompson.


## Installation

Install with [npm](https://www.npmjs.com/)

```sh
$ npm i npm-font-caviar-dreams --save
```


## Usage

This a sample for usage in a LESS file:

```
# part of your LESS file
@import '../../../node_modules/npm-font-caviar-dreams/caviar-dreams';
@FontPathCaviarDreams: "../fonts/caviar-dreams";
```

First import the LESS file of the font and after this overwrite the default path. That's it ...

You can do the same with SCSS/SASS too ...

```
# part of your SCSS file
$FontPathCaviarDreams: "../fonts/caviar-dreams";
@import '../../../node_modules/npm-font-caviar-dreams/caviar-dreams';
```

You can do the same with Stylus too ...

```
# part of your SCSS file
$FontPathCaviarDreams = "../fonts/caviar-dreams";
@import '../../../node_modules/npm-font-caviar-dreams/caviar-dreams.styl';
```


## Source of font files

[Caviar Dreams at DaFont](https://www.dafont.com/caviar-dreams.font)


## License

[Custom Licence](https://github.com/matthewbooth/npm-font-caviar-dreams/blob/master/LICENSE)

Please do not hesitate to get in touch if this licence is not correct.

I've borrowed much of the formatting for this package from [npm-font-open-sans](https://github.com/dasrick/npm-font-open-sans) to simply save time.

***

[github-tag-image]: https://img.shields.io/github/tag/matthewbooth/npm-font-caviar-dreams.svg?style=flat-square
[github-tag-url]: https://github.com/matthewbooth/npm-font-caviar-dreams

[npm-version-image]: https://img.shields.io/npm/v/npm-font-caviar-dreams.svg?style=flat-square
[npm-version-url]: https://www.npmjs.com/package/npm-font-caviar-dreams
[npm-downloads-image]: https://img.shields.io/npm/dm/npm-font-caviar-dreams.svg?style=flat-square
[npm-downloads-url]: https://www.npmjs.com/package/npm-font-caviar-dreams