diff --git a/CD_QUICK_START.md b/CD_QUICK_START.md new file mode 100644 index 0000000..7144bf7 --- /dev/null +++ b/CD_QUICK_START.md @@ -0,0 +1,84 @@ +# Continuous Delivery - Quick Start + +## Start Auto-Deployment in 10 Seconds + +```powershell +.\start-cd.ps1 watch +``` + +That's it! Your changes will now automatically commit and push to GitHub. + +## What Happens Now? + +1. Edit any file and save +2. Wait 30 seconds after your last change +3. Automatically commits with change summary +4. Automatically pushes to GitHub +5. Repeat! + +## Common Commands + +```powershell +# Start file watcher (recommended) +.\start-cd.ps1 watch + +# Start timer mode (every 5 minutes) +.\start-cd.ps1 start + +# Commit and push once, right now +.\start-cd.ps1 once + +# Stop all CD processes +.\start-cd.ps1 stop + +# Check git status +.\start-cd.ps1 status +``` + +## Example Output + +``` +[14:23:45] Changed: setup.php +[14:23:47] Changed: docker-compose.yml + +Debounce period elapsed. Processing 2 changes... +ℹ Found 2 changed files +✓ Committed changes +✓ Successfully pushed to GitHub + +Continuing to watch for changes... +``` + +## What Gets Auto-Committed? + +- Application code (PHP, JS, CSS) +- Configuration files +- Documentation +- SQL schemas + +## What's Excluded? + +- Session files (`f_data/data_sessions/`) +- Cache files (`f_data/data_cache/`) +- Database files (`db_data/`) +- Log files (`*.log`) +- Dependencies (`node_modules/`, `vendor/`) + +## Troubleshooting + +**Not detecting changes?** +- Check if file is in `.gitignore` + +**Need to stop?** +- Press `Ctrl+C` or run `.\start-cd.ps1 stop` + +**Want custom settings?** +- Edit `.cd-config.json` + +## Full Documentation + +See [CONTINUOUS_DELIVERY_GUIDE.md](CONTINUOUS_DELIVERY_GUIDE.md) for complete documentation. + +--- + +**Ready?** Run `.\start-cd.ps1 watch` and start coding!