diff --git a/.github/tailwindcss-mark.svg b/.github/tailwindcss-mark.svg new file mode 100644 index 0000000..6a9ab49 --- /dev/null +++ b/.github/tailwindcss-mark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/README.md b/README.md index 57a4053..03eef42 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ -# tailwindcss-email-variants +
+ Tailwind CSS +

Tailwind CSS Email Variants

-A plugin that provides variants for email client targeting hacks used in HTML emails. + [![Build][github-ci-shield]][github-ci] + [![License][license-shield]][license] +
+ +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) @@ -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 @@ -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