feat: add readme

nashtech-garage · Dec 3, 2024 · 86ad4ea · 86ad4ea
1 parent f2efd17
commit 86ad4ea
Showing 1 changed file with 72 additions and 0 deletions.
diff --git 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 `<head>` section of your HTML file.
+
+```html
+<!doctype html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <meta
+            name="viewport"
+            content="width=device-width, initial-scale=1.0"
+        />
+        <link
+            href="node_modules/nt-css/dist/styles.css"
+            rel="stylesheet"
+        />
+        <title>Example</title>
+    </head>
+    <body>
+        <h1 class="text-3xl font-bold underline">Hello, nt-css!</h1>
+    </body>
+</html>
+```
+
+### 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.