@beamwind/preset-tailwind/README.md

# @beamwind/preset-tailwind

> beamwind preset mirroring the [tailwind default theme](https://github.com/tailwindlabs/tailwindcss/blob/master/stubs/defaultConfig.stub.js)

[![MIT License](https://flat.badgen.net/github/license/kenoxa/beamwind)](https://github.com/kenoxa/beamwind/blob/main/LICENSE)
[![Latest Release](https://flat.badgen.net/npm/v/@beamwind/preset-tailwind?icon=npm&label)](https://www.npmjs.com/package/@beamwind/preset-tailwind)
[![Github](https://flat.badgen.net/badge/icon/kenoxa%2Fbeamwind?icon=github&label)](https://github.com/kenoxa/beamwind/blob/main/packages/preset-tailwind)
[![Typescript](https://flat.badgen.net/badge/icon/included?icon=typescript&label)](https://unpkg.com/browse/@beamwind/preset-tailwind/types/preset-tailwind.d.ts)
[![Bundle Size](https://flat.badgen.net/bundlephobia/minzip/@beamwind/preset-tailwind?icon=packagephobia&label&color=blue)](https://bundlephobia.com/result?p=@beamwind/preset-tailwind)

> [Read the docs](https://beamwind.js.org) |
> [API](https://beamwind.js.org/packages/preset-tailwind) |
> [Change Log](https://github.com/kenoxa/beamwind/blob/main/packages/preset-tailwind/CHANGELOG.md)

---

> This is a only a preset. [beamwind](https://github.com/kenoxa/beamwind/blob/main/packages/beamwind) provides a ready to use `bw` export.

---

<!-- prettier-ignore-start -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Installation](#installation)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- prettier-ignore-end -->

## Installation

```sh
npm install @beamwind/preset-tailwind
```

## Usage

> Please refer to the [main documentation](https://beamwind.js.org#usage) for further information.

```js
import { setup } from '@beamwind/core'
import tailwind from '@beamwind/preset-tailwind'

setup(tailwind())
```

See [preset-tailwind/src/theme.ts](https://github.com/kenoxa/beamwind/blob/main/packages/preset-tailwind/src/theme.ts) and [core/src/theme.ts](https://github.com/kenoxa/beamwind/blob/main/packages/core//src/theme.ts) for the set values.

## Contribute

Thanks for being willing to contribute!

> This project is free and open-source, so if you think this project can help you or anyone else, you may [star it on GitHub](https://github.com/kenoxa/beamwind). Feel free to [open an issue](https://github.com/kenoxa/beamwind/issues) if you have any idea, question, or you've found a bug.

**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

We are following the [Conventional Commits](https://www.conventionalcommits.org) convention.

### Sponsors

[![Kenoxa GmbH](https://images.opencollective.com/kenoxa/9c25796/logo/68.png)](https://www.kenoxa.com) [Kenoxa GmbH](https://www.kenoxa.com)

## License

[MIT](https://github.com/kenoxa/beamwind/blob/main/LICENSE) © [Kenoxa GmbH](https://kenoxa.com)