Skip to content

Commit

Permalink
chore: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cossssmin committed Jan 28, 2024
1 parent e274d5f commit bab9973
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
1 change: 1 addition & 0 deletions .github/tailwindcss-mark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# tailwindcss-email-variants
<div align="center">
<img src="./.github/tailwindcss-mark.svg" alt="Tailwind CSS" width="108" height="66">
<h1>Tailwind CSS Email Variants</h1>

A plugin that provides variants for email client targeting hacks used in HTML emails.
[![Build][github-ci-shield]][github-ci]
[![License][license-shield]][license]
</div>

A Tailwind CSS plugin that provides variants for email client targeting hacks used in HTML emails.

All variants are based on targeting hacks from [howtotarget.email](https://howtotarget.email)

Expand All @@ -15,21 +21,18 @@ npm install -D tailwindcss-email-variants
Then add the plugin to your `tailwind.config.js` file:

```js
// tailwind.config.js
/** @type {import('tailwindcss').Config} */
module.exports = {
theme: {
// ...
},
// ...
plugins: [
require('tailwindcss-email-variants'),
// ...
],
}
```

## Usage

Use the available variants to generate utilities that target specific email clients, or [configure it](#configuration) with your own variants.
Use the available variants to generate utilities that target specific email clients.

### Gmail

Expand Down Expand Up @@ -156,3 +159,8 @@ Result:
display: none;
}
```

[github-ci]: https://github.com/maizzle/tailwindcss-email-variants/actions
[github-ci-shield]: https://github.com/maizzle/tailwindcss-email-variants/actions/workflows/nodejs.yml/badge.svg
[license]: ./LICENSE
[license-shield]: https://img.shields.io/github/license/maizzle/tailwindcss-email-variants?color=0e9f6e

0 comments on commit bab9973

Please sign in to comment.