next-configure 0.1.2 → 0.1.4

package/README.md

@@ -1,51 +1,139 @@
 # next-configure
 
-Zero-config CLI to wire up Tailwind v4 + shadcn/ui and basic structure in a Next.js App Router project.
+Minimal CLI tool to configure Next.js projects quickly and cleanly.
 
 ## Install
 
-Use directly with `npx`:
+Run directly with `npx` from your Next.js project root:
 
 ```bash
 npx next-configure
 ```
 
-Or install as a dev dependency:
+This should be executed inside an existing Next.js App Router project (where `package.json` with `next` is present).
 
-```bash
-npm install --save-dev next-configure
-```
+---
 
-Then run:
+## Overview
 
-```bash
-npx next-configure
-```
+`next-configure` automates common setup tasks you usually repeat after running `create-next-app`:
 
-## What it does
+- Detects a valid Next.js App Router project.
+- Optionally installs and wires up `shadcn/ui`.
+- Creates standard development folders.
+- Generates a Tailwind v4–compatible theme in `globals.css` from your brand colors.
 
-- Verifies you are in a Next.js project (`next` in `dependencies` or `devDependencies`).
-- Detects `src/` and creates `components`, `hooks`, `utils` in `src/` or project root.
-- Optionally runs `shadcn init` and installs the `button` component.
-- Locates `src/app/globals.css` or `app/globals.css` and overwrites it with:
-  - Tailwind v4 imports (`@import "tailwindcss";`, `@import "tw-animate-css";`)
-  - `@theme inline` mapping Tailwind tokens to CSS variables
-  - `:root` variables for primary/secondary (with auto light/dark variants) and core UI colors
-  - A minimal `@layer base` for body and border styles
+The goal is to speed up setup while staying minimal and under your control.
 
-## Usage
+---
 
-Run from the root of your Next.js App Router project:
+## CLI Demo
+
+Example interaction:
 
 ```bash
-npx next-configure
+$ npx next-configure
+
+✔ Detected Next.js project
+? Do you want to install shadcn/ui? › yes
+✔ Installing shadcn/ui
+
+? Do you want to generate standard development folders? › yes
+✔ Created components
+✔ Created hooks
+✔ Created utils
+
+? Do you want to set color theme? › yes
+? Enter primary color (hex without #) › 2563eb
+? Enter secondary color (hex without #) › f97316
+
+✔ globals.css overwritten successfully
+✔ Setup complete
 ```
 
-You will be asked:
+---
+
+## What It Configures
+
+### Folders
+
+If you opt in:
+
+- When `src/` exists:
+  - `src/components`
+  - `src/hooks`
+  - `src/utils`
+- Otherwise:
+  - `components`
+  - `hooks`
+  - `utils`
+
+Existing folders are left as-is; missing ones are created.
+
+### Theme in `globals.css`
+
+If you choose to set a color theme:
+
+- Locates one of:
+  - `src/app/globals.css`
+  - `app/globals.css`
+- Overwrites it with:
+  - Tailwind v4–style imports:
+    - `@import "tailwindcss";`
+    - `@import "tw-animate-css";`
+  - A theme based on CSS variables:
+    - Primary and secondary colors (from your input).
+    - Automatically generated light and dark variants.
+  - Utility classes, for example:
+    - `bg-primary`, `bg-secondary`
+    - `text-primary`, `text-secondary`
+
+If `globals.css` is not found in `app/` or `src/app/`, the CLI exits with a clear error.
+
+---
+
+## Design Principles
+
+- Minimal surface area.
+- No enforced application architecture.
+- Does not touch layout or routing files.
+- Uses a small, focused dependency set.
+- All major actions are opt-in via prompts.
+
+---
+
+## Requirements
+
+- Node.js **18+**
+- Next.js **13+** with **App Router**
+- Tailwind v4-compatible setup with `globals.css` under `app/` or `src/app/`
+
+---
+
+## Contributing
+
+This project is open source. Contributions are welcome.
+
+- For substantial changes, please open an issue first to discuss the direction.
+- For small fixes or improvements, submit a pull request with a clear description.
+
+Please keep changes aligned with the goals of being minimal, predictable, and Next.js App Router–focused.
+
+---
+
+## Issues
+
+If you run into a bug or want to request a feature:
+
+- Open an issue on GitHub with:
+  - Steps to reproduce (if applicable).
+  - Your Node.js and Next.js versions.
+  - Any relevant CLI output.
+
+Source code and issue tracker: https://github.com/bilal-dev02/next-configure
+
+---
 
-1. Whether to install shadcn/ui.
-2. Whether to create `components`, `hooks`, `utils` folders.
-3. Whether to set a color theme.
-   - If yes, enter primary and secondary hex colors (without `#`).
+## License
 
-If globals.css is missing in `app/` or `src/app/`, the CLI exits with a clear error.
+MIT

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "next-configure",
-  "version": "0.1.2",
-  "description": "Zero-config CLI to  Tailwind v4 + shadcn/ui theme and folder structure in Next.js App Router projects.",
+  "version": "0.1.4",
+  "description": "Zero-config CLI to wire up Tailwind v4 + shadcn/ui and structure in a Next.js App Router project.",
+  "license": "MIT",
   "type": "module",
   "bin": {
     "next-configure": "./dist/index.js"
@@ -38,6 +39,14 @@
     "theme",
     "design system"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bilal-dev02/next-configure.git"
+  },
+  "homepage": "https://github.com/bilal-dev02/next-configure",
+  "bugs": {
+    "url": "https://github.com/bilal-dev02/next-configure/issues"
+  },
   "files": [
     "dist",
     "README.md"