Skip to content

Commit a7c0133

Browse files
committed
up
1 parent f146f3a commit a7c0133

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,32 @@ OpenAPI (Swagger) docs, and zero code generation.
3535

3636
## 📦 Installation
3737

38-
### Option 1: Install as Library (Recommended)
38+
### Option 1: Install as Library (Recommended)
3939

40-
Install via Composer (Packagist):
40+
**Just 4 simple steps:**
4141

4242
```bash
43+
# 1. Install via Composer
4344
composer require bitshost/php-crud-api-generator
44-
```
45-
46-
Then copy 3 files to your project root and modify 2 lines:
4745

48-
```bash
49-
# Copy files
46+
# 2. Copy 3 files to your project root
5047
copy vendor/bitshost/php-crud-api-generator/public/index.php index.php
5148
copy vendor/bitshost/php-crud-api-generator/dashboard.html dashboard.html
5249
copy vendor/bitshost/php-crud-api-generator/health.php health.php
5350

54-
# Edit index.php - change 2 config paths to point to vendor (see QUICK_START.md)
51+
# 3. Edit index.php - Change 2 lines (point config paths to vendor)
52+
# Change: require __DIR__ . '/config/...'
53+
# To: require __DIR__ . '/vendor/bitshost/php-crud-api-generator/config/...'
54+
55+
# 4. Configure & run
56+
notepad vendor/bitshost/php-crud-api-generator/config/db.php
57+
notepad vendor/bitshost/php-crud-api-generator/config/api.php
58+
php -S localhost:8000
5559
```
5660

57-
**See [Quick Start Guide →](docs/QUICK_START.md) for detailed 5-minute setup.**
61+
**That's it!** Total modifications: **2 lines of code** 🚀
62+
63+
**📖 [5-Minute Quick Start Guide →](docs/QUICK_START.md)**
5864

5965
### Option 2: Standalone Project
6066

0 commit comments

Comments
 (0)