From 87aefa3d48f95d537efc38bcbeef155b6640b444 Mon Sep 17 00:00:00 2001 From: Natxo <1172351+natxocc@users.noreply.github.com> Date: Tue, 31 Mar 2026 12:59:30 +0200 Subject: [PATCH] Update Readme.md --- Readme.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/Readme.md b/Readme.md index 001b46f..788b882 100644 --- a/Readme.md +++ b/Readme.md @@ -24,12 +24,19 @@ To use SigPro UI, your project must include: 2. **Tailwind CSS v4**: For utility-first styling. 3. **daisyUI v5**: The component engine for Tailwind. ---- -## Installation +## 1. Prerequisites & Installation +SigPro UI is built as an extension of the SigPro reactivity system. You need to install the core library first. -### Via Bun or NPM -```bash +### Step 1: Install SigPro Core +´´´Bash +bun add sigpro +# or +npm install sigpro +``` +### Step 2: Install SigPro UI + +```Bash bun add sigpro-ui # or npm install sigpro-ui @@ -40,9 +47,25 @@ npm install sigpro-ui ``` - --- +## 2. Styling Setup (Tailwind CSS v4) +SigPro UI components rely on **Tailwind CSS** and **daisyUI** for styling. You don't need a complex tailwind.config.js; simply configure your main CSS entry point. + +Create or edit your global CSS file (e.g., style.css): + +´´´CSS +/* src/style.css */ +@import "tailwindcss"; +@plugin "daisyui"; + +/* Optional: Your custom theme overrides */ +:root { + --primary: #570df8; + --secondary: #f000b8; +} +``` +--- ## Setup & Usage You can use SigPro UI in two ways: **Modular** (Recommended for production) or **Global** (Fastest for prototyping).