From 786df08aa2bb33f1a257a6064f6fab6e264a0894 Mon Sep 17 00:00:00 2001 From: khoinashtech Date: Tue, 24 Dec 2024 10:38:26 +0700 Subject: [PATCH] feat: update readme file --- apps/nt-stylesheet/README.md | 18 ++++++++++++++---- apps/nt-stylesheet/package.json | 2 +- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/apps/nt-stylesheet/README.md b/apps/nt-stylesheet/README.md index 75828c4..ab6c0f6 100644 --- a/apps/nt-stylesheet/README.md +++ b/apps/nt-stylesheet/README.md @@ -24,9 +24,9 @@ npx nt-stylesheet ### Usage -You can customize nt-stylesheet by editing the `tailwind.config.js` file. Add your own styles or override existing ones to fit your design needs. +1. **Include the Stylesheet** -- Import css file +Add the following line to your HTML file to include the `nt-stylesheet` theme: ```html ``` -- Import theme file to tailwind config +2. **Import Theme File to Tailwind Config** + +Create or update your tailwind.config.js file to include the nt-stylesheet theme: ```js /** @type {import('tailwindcss').Config} */ @@ -50,6 +52,14 @@ module.exports = { } ``` +3. **Execute Your Styles** + +Run the following command to generate your CSS file: + +```bash +npx tailwindcss -i ./input.css -o ./dist/output.css --watch +``` + ### Acknowledgements -`nt-stylesheet` is built upon the powerful Tailwind CSS framework, making it easy to use and customize. We extend our gratitude to the Tailwind CSS community for their continuous support and contributions. +`nt-stylesheet` is built upon the powerful Tailwind CSS framework, making it easy to use and customize. diff --git a/apps/nt-stylesheet/package.json b/apps/nt-stylesheet/package.json index 35dd65d..710b52e 100644 --- a/apps/nt-stylesheet/package.json +++ b/apps/nt-stylesheet/package.json @@ -1,6 +1,6 @@ { "name": "nt-stylesheet", - "version": "1.1.12", + "version": "1.1.13", "description": "Style sheet for the NT Design System", "packageManager": "pnpm@9.0.5", "scripts": {