readme added

Author: mehediScriptDev

README.md

@@ -1,79 +1,60 @@
 # CrapUi
 
-A small, lightweight collection of React UI building blocks and a Vite starter template for quickly prototyping interfaces.
+A simple, ready-to-use Vite + React + React Router starter with Tailwind and Context API.
 
-## Quick Start
+<p align="center">
+  <img src="templates/basic/public/crapui.png" alt="CrapUi Logo" width="180" />
+</p>
 
-Create a new project with one command:
+**Quick Install**
+
+- One-line (no global install):
 
 ```bash
-npx crap-ui my-app
-cd my-app
+npx crap-ui my-project
+cd my-project
 npm run dev
 ```
 
-That's it! Your Vite + React + Tailwind project is ready.
-
-## Manual Installation
-
-- **Prerequisites**: Node.js `>=16` and `npm` (or `pnpm` / `yarn`).
-- **Clone the repository**:
+- Or install CLI globally and run:
 
 ```bash
-git clone https://github.com/mehediScriptDev/CrapUi.git
-cd CrapUi
+npm install -g crap-ui
+crap-ui my-project
+cd my-project
+npm run dev
 ```
 
-- **Install dependencies**:
-
-```bash
-npm install
-# or: pnpm install
-```
+**What this project contains**
 
-**Project Setup**
+- **Vite** — latest fast dev server and build tooling.
+- **React** (latest) + **React Router** (latest) for routing.
+- **Tailwind CSS** — utility-first styling preconfigured.
+- **Context API** — example auth/context setup included in `src/context`.
+- Example components in `src/Components` and a ready `templates/basic` starter.
 
-- **Run the development server**:
+**How to use locally (if you cloned this repo)**
 
 ```bash
+git clone https://github.com/mehediScriptDev/CrapUi.git
+cd CrapUi/templates/basic
+npm install
 npm run dev
-# opens local dev server (Vite)
 ```
 
-- **Build for production**:
+**Why use this**
 
-```bash
-npm run build
-```
+- Fast project scaffolding with sensible defaults.
+- Minimal, unopinionated setup so you can add your own libraries.
+- Includes Context API examples to get you started with global state.
 
-- **Preview the production build locally**:
+**Contributing & Support**
 
-```bash
-npm run preview
-```
+- If you like the project, please star this repo.
+- Found a bug or have a feature idea? Open an issue on GitHub.
+- Contributions are welcome — feel free to open a pull request.
 
-- **Quick-start from the template**: the `templates/basic` folder contains a ready-to-use Vite + React setup. To create a new project from the template:
+**License**
 
-```bash
-cp -R templates/basic my-new-project
-cd my-new-project
-npm install
-npm run dev
-```
-
-- **Key paths**:
-  - `src/` — application source files
-  - `src/Components/` — example UI components (buttons, layout helpers, etc.)
-  - `templates/basic/` — standalone starter template you can copy or adapt
-
-**Benefits**
+This project is released under the MIT License.
 
-- **Fast development**: Vite-based setup gives near-instant hot reload and minimal setup time.
-- **Ready examples**: example components live in `src/Components` so you can reuse or extend them.
-- **Template-driven**: `templates/basic` is a drop-in starter for new projects — copy and go.
-- **Small and flexible**: minimal opinionated glue so you can add your preferred styling system easily.
-
-If you want, I can add a short example showing how to import and use a component from `src/Components` in `src/App.jsx`.
-# CrapUi
-A small collection of React + Tailwind components I build daily...simple and reusable.
-<img src="crapui.jpg"/>

package.json

@@ -4,7 +4,7 @@
   "version": "1.0.0",
   "type": "module",
   "description": "A lightweight Vite + React + Tailwind starter template",
-  "keywords": ["react", "vite", "tailwind", "template", "starter", "scaffold", "boilerplate"],
+  "keywords": ["react tailwind project setup", "react tailwind", "vite", "react tailwind template", "tailwind", "template", "starter", "scaffold", "boilerplate"],
   "author": "Mehedi",
   "license": "MIT",
   "repository": {