Merge pull request #74 from maizzle/refactor/vitest

Author: cossssmin

.github/tailwindcss-mark.svg

@@ -1,7 +1,7 @@
 # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: Node.js CI
+name: build
 
 on:
   push:
@@ -14,15 +14,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12, 14, 16]
+        node-version: [18, 20]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm install
+      - run: npm ci
       - run: npm test
         env:
           CI: true

.github/workflows/nodejs.yml

@@ -1,4 +1,5 @@
 .vscode
+coverage
 node_modules
 npm-debug.log
 yarn-error.log

.gitignore

@@ -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)
 
@@ -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