up

Author: BitsHost

README.md

@@ -29,11 +29,37 @@ OpenAPI (Swagger) docs, and zero code generation.
 📖 **[See detailed enhancement documentation →](ENHANCEMENTS.md)**
 📖 **[Rate Limiting Documentation →](docs/RATE_LIMITING.md)**
 📖 **[Request Logging Documentation →](docs/REQUEST_LOGGING.md)**
+📖 **[Quick Start (5 minutes) →](docs/QUICK_START.md)**
 
 ---
 
 ## 📦 Installation
 
+### Option 1: Install as Library (Recommended)
+
+Install via Composer (Packagist):
+
+```bash
+composer require bitshost/php-crud-api-generator
+```
+
+Then copy 3 files to your project root and modify 2 lines:
+
+```bash
+# Copy files
+copy vendor/bitshost/php-crud-api-generator/public/index.php index.php
+copy vendor/bitshost/php-crud-api-generator/dashboard.html dashboard.html
+copy vendor/bitshost/php-crud-api-generator/health.php health.php
+
+# Edit index.php - change 2 config paths to point to vendor (see QUICK_START.md)
+```
+
+**See [Quick Start Guide →](docs/QUICK_START.md) for detailed 5-minute setup.**
+
+### Option 2: Standalone Project
+
+Clone or download the full project:
+
 ```bash
 composer create-project bitshost/php-crud-api-generator
 ```
@@ -42,13 +68,28 @@ composer create-project bitshost/php-crud-api-generator
 
 ## ⚙️ Configuration
 
+### If installed as library (via composer require):
+
+Edit config files in vendor directory:
+
+```bash
+notepad vendor/bitshost/php-crud-api-generator/config/db.php
+notepad vendor/bitshost/php-crud-api-generator/config/api.php
+```
+
+### If standalone project (via composer create-project):
+
 Copy and edit config files:
 
 ```bash
 cp config/db.example.php config/db.php
 cp config/api.example.php config/api.php
 ```
 
+---
+
+**Config file structure:**
+
 Edit `config/db.php`:
 
 ```php

docs/QUICK_START.md

@@ -0,0 +1,104 @@
+# Quick Start - bitshost/php-crud-api-generator
+
+**Get started in 5 minutes!**
+
+---
+
+## Step 1: Install
+
+```bash
+composer require bitshost/php-crud-api-generator
+```
+
+---
+
+## Step 2: Copy 3 files to project root
+
+```bash
+copy vendor\bitshost\php-crud-api-generator\public\index.php index.php
+copy vendor\bitshost\php-crud-api-generator\dashboard.html dashboard.html
+copy vendor\bitshost\php-crud-api-generator\health.php health.php
+```
+
+---
+
+## Step 3: Edit index.php (2 lines)
+
+Change config paths to point to vendor:
+
+```php
+// Change this:
+$dbConfig = require __DIR__ . '/config/db.php';
+$apiConfig = require __DIR__ . '/config/api.php';
+
+// To this:
+$dbConfig = require __DIR__ . '/vendor/bitshost/php-crud-api-generator/config/db.php';
+$apiConfig = require __DIR__ . '/vendor/bitshost/php-crud-api-generator/config/api.php';
+```
+
+---
+
+## Step 4: Configure (in vendor directory)
+
+```bash
+notepad vendor\bitshost\php-crud-api-generator\config\db.php
+notepad vendor\bitshost\php-crud-api-generator\config\api.php
+```
+
+**db.php:**
+```php
+return [
+    'host' => 'localhost',
+    'dbname' => 'your_database',
+    'user' => 'root',
+    'pass' => '',
+    'charset' => 'utf8mb4'
+];
+```
+
+**api.php - Generate JWT secret:**
+```bash
+php -r "echo bin2hex(random_bytes(32));"
+```
+
+Paste result into api.php:
+```php
+'jwt_secret' => 'YOUR_64_CHAR_SECRET_HERE',
+```
+
+---
+
+## Step 5: Run!
+
+```bash
+php -S localhost:8000
+```
+
+---
+
+## Test
+
+```bash
+# Login
+curl -X POST -d "username=admin&password=password123" http://localhost:8000/?action=login
+
+# View dashboard
+http://localhost:8000/dashboard.html
+```
+
+---
+
+## Summary
+
+**3 files copied:**
+- index.php (2 lines modified)
+- dashboard.html (0 modifications)
+- health.php (0 modifications)
+
+**2 files edited:**
+- vendor/.../config/db.php
+- vendor/.../config/api.php
+
+**Total code changes: 2 lines!** 🎉
+
+That's it! Your API is ready. All configs stay in vendor directory - clean and simple!