fix: Address PR feedback and improve documentation setup

Fixes #31

- Remove docs/CNAME.example (not needed for custom domain)
- Replace python server with universal http-server in package.json
- Add http-server as dev dependency for cross-platform compatibility
- Simplify README description and structure for better readability
- Fix GitHub Actions permissions for Pages deployment
- Add proper token handling in workflow
- Update documentation serving instructions

Changes made:
✅ Universal server solution (npx http-server)
✅ Cleaner README with table format
✅ Removed unnecessary CNAME file
✅ Enhanced workflow permissions
✅ Better developer experience

Author: Shubham15986

.github/workflows/deploy-docs.yml

@@ -16,13 +16,19 @@ concurrency:
 
 jobs:
   deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup Pages
         uses: actions/configure-pages@v4

README.md

@@ -1,28 +1,34 @@
 # create-next-quick
 
-**create-next-quick** is a CLI tool that lets you instantly create a new Next.js project with your choice of options.
+⚡ **Fast Next.js project scaffolding with interactive setup**
+
+A lightweight CLI tool that creates Next.js projects with your preferred configuration - TypeScript, Tailwind CSS, ORMs, linters, and more.
 
 📖 **[View Documentation](https://gaureshpai.github.io/create-next-quick/)** | 🚀 **[Quick Start](#installation)**
 
-## Why create-next-quick?
+---
+
+## ✨ Why choose create-next-quick?
 
-`create-next-quick` is a lightweight and fast alternative to `create-next-app`. It provides an interactive setup process that lets you choose the options you want for your project, such as TypeScript, Tailwind CSS, and the Next.js app directory. It also lets you create multiple pages at once, which can save you a lot of time when starting a new project.
+- **🚀 Faster setup** - Skip repetitive configuration steps
+- **🎯 Interactive prompts** - Choose exactly what you need
+- **📄 Multiple pages** - Generate several pages at once
+- **🔧 Modern tools** - Built-in support for TypeScript, Tailwind, ORMs
+- **🧹 Clean output** - No unnecessary boilerplate files
 
-## Features
+## 🎯 Key Features
 
-- **CLI Argument for Project Name** — skip the project name prompt by passing the app name as a CLI argument.
-- **Package Manager Detection** — automatically detects installed package managers (`npm`, `yarn`, `pnpm`) and only prompts with available options.
-- **Next.js App Directory** — support for the new Next.js app directory.
-- **Custom Page Generation** — create multiple pages at once.
-- **Linter Support** — choose between no linter, ESLint, and Biome.
-- **Shadcn UI** — automatically installs and configures Shadcn UI with a default style and color.
-- **Clean Project Setup** — removes default favicon and clears public folder.
-- **Empty Default Page** — overwrites the default `page.tsx` or `index.tsx` with an empty template.
-- **Dynamic Metadata** — always overwrites the `layout.tsx` or `layout.jsx` with a minimal template.
-- **Conditional API Route Deletion** — deletes the default `api/hello.js` route if using the `src` directory and not the `app` directory.
-- **Safe Project Creation** — checks if the current directory is empty when creating a project in the current directory (`.`) and prevents accidental overwrites.
-- **ORM Support** — choose between no ORM, Prisma, and Drizzle.
-- **Automated CI/CD Feedback** — Pull Requests now receive automated comments on test status.
+| Feature | Description |
+|---------|-------------|
+| **Smart Project Names** | Pass project name as argument to skip prompts |
+| **Package Manager Detection** | Auto-detects npm, yarn, pnpm |
+| **Modern Next.js** | App directory, TypeScript, Tailwind CSS |
+| **Multiple Pages** | Generate several pages in one go |
+| **Linting Options** | ESLint, Biome, or none |
+| **Database Ready** | Prisma, Drizzle ORM integration |
+| **UI Components** | Shadcn UI with auto-configuration |
+| **Clean Setup** | No unnecessary files or boilerplate |
+| **Safe Creation** | Prevents accidental overwrites |
 
 ## Installation
 
@@ -121,12 +127,17 @@ To run the tests:
 To work with the documentation locally:
 
 ```bash
-# Serve docs locally (requires Python)
+```bash
+# Install dependencies first
+npm install
+
+# Serve documentation locally (uses http-server)
 npm run docs:serve
 
-# Open documentation website
+# Open documentation in browser
 npm run docs:open
 ```
+```
 
 The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.
 

docs/CNAME.example

@@ -1,4 +1,9 @@
 <!DOCTYPE html>
+<!-- 
+    Enhanced Documentation Site for create-next-quick
+    Resolves: Enhanced Documentation with Copy Functionality and Improved Design
+    Features: Interactive copy buttons, responsive design, comprehensive guides
+-->
 <html lang="en">
 <head>
     <meta charset="UTF-8">

docs/index.html

@@ -13,7 +13,7 @@
     "test": "npm run test:generate && mocha",
     "test:generate": "node test/generate-tests.js",
     "start": "node index.js",
-    "docs:serve": "cd docs && python -m http.server 8080",
+    "docs:serve": "npx http-server docs -p 8080",
     "docs:open": "open https://gaureshpai.github.io/create-next-quick/"
   },
   "bin": {
@@ -48,6 +48,7 @@
   },
   "devDependencies": {
     "inquirer-test": "^2.0.1",
-    "mocha": "^11.7.3"
+    "mocha": "^11.7.3",
+    "http-server": "^14.1.1"
   }
 }