From 86ad4ea68d232e1afb4e341b4aa4439d1c0c1914 Mon Sep 17 00:00:00 2001 From: khoinashtech Date: Tue, 3 Dec 2024 13:47:08 +0700 Subject: [PATCH] feat: add readme --- apps/nt-css/Readme.md | 72 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/apps/nt-css/Readme.md b/apps/nt-css/Readme.md index e69de29..bb5a410 100644 --- a/apps/nt-css/Readme.md +++ b/apps/nt-css/Readme.md @@ -0,0 +1,72 @@ +# nt-css + +## Overview + +**nt-css** is a lightweight, customizable CSS framework designed to simplify the process of styling your web projects. It leverages the power of Tailwind CSS to provide a robust set of utility classes, enabling you to build responsive and modern UIs with ease. + +## Features + +- Simple to use +- Customizable with utility classes +- Lightweight and fast +- Responsive design support +- Integration with Tailwind CSS + +## Installation + +You can install **nt-css** via npm or pnpm. + +### Using npm + +```sh +npm install nt-css +``` + +### Usage + +To use nt-css in your project, include the generated `styles.css` file in the `` section of your HTML file. + +```html + + + + + + + Example + + +

Hello, nt-css!

+ + +``` + +### Customization + +You can customize nt-css by editing the `tailwind.config.js` file. Add your own styles or override existing ones to fit your design needs. + +```js +/** @type {import('tailwindcss').Config} */ +module.exports = { + content: ['./src/**/*.{html,js}'], + theme: { + extend: { + colors: { + primary: '#ff6347', + secondary: '#4b5563', + }, + }, + }, + plugins: [], +} +``` + +### Acknowledgements + +`nt-css` 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.