typerules/README.md

A typography toolkit that sets vertical rhythm and provides type functions.

# Typerules ![Open Source Love](https://github.com/ellerbrock/open-source-badges/blob/master/badges/open-source-v3/open-source.svg)

<p align="right">
  <code>LIKED ? Leave a <a href="https://github.com/tiagoporto/typerules/stargazers">⭐</a> : <a href="https://github.com/tiagoporto/typerules/issues">😞</a></code>
</p>

[![Release](https://img.shields.io/npm/v/typerules.svg?style=flat-square&label=release)](https://github.com/tiagoporto/typerules/releases)
[![Downloads](https://img.shields.io/npm/dt/typerules.svg?style=flat-square)](https://www.npmjs.com/package/typerules)
[![install size](https://packagephobia.now.sh/badge?p=typerules)](https://packagephobia.now.sh/result?p=typerules)
[![License](https://img.shields.io/github/license/tiagoporto/typerules.svg?style=flat-square)](https://raw.githubusercontent.com/tiagoporto/typerules/master/LICENSE)

[![Build Status](https://img.shields.io/travis/com/tiagoporto/typerules/master.svg?label=tests&logo=travis&style=flat-square)](https://travis-ci.com/tiagoporto/typerules)
[![devDependencies Status](https://img.shields.io/david/dev/tiagoporto/typerules.svg?style=flat-square)](https://david-dm.org/tiagoporto/typerules?type=dev)

> A toolkit that sets typography settings, vertical rhythm, and more.

_Work in Progress_

## Installation

```sh
npm i typerules@alpha
```

## Usage

```stylus
@import '~typerules'
```

## Options

### Show grid

```stylus
$debug-vertical-rhythm = true

@import '~typerules'
```

### Generate basic styles

```stylus
@import '~typerules'

set-rhythm()
```

<!-- ## Settings -->

<!-- ## Functions -->

## Contributing

[See how to contribute](CONTRIBUTING.md).

## License

Typerules is released under the terms of the [MIT](LICENSE).