update readme

Author: fqjony

README.md

@@ -1,154 +1,160 @@
-# UDX Worker PHP
-
-[![Docker Pulls](https://img.shields.io/docker/pulls/usabilitydynamics/udx-worker-php.svg)](https://hub.docker.com/r/usabilitydynamics/udx-worker-php) [![License](https://img.shields.io/github/license/udx/worker-php.svg)](LICENSE)
+<img src="assets/logo.svg" alt="UDX Worker PHP">
 
-**A versatile Docker image for running PHP applications with NGINX and PHP-FPM, providing a ready-to-use environment to deploy and serve your PHP projects.**
+# UDX Worker PHP
 
-[Quick Start](#-quick-start) • [Development](#-development) • [Deployment](#-deployment) • [Contributing](#-contributing)
+[![Docker Pulls](https://img.shields.io/docker/pulls/usabilitydynamics/udx-worker-php.svg)](https://hub.docker.com/r/usabilitydynamics/udx-worker-php)
+[![License](https://img.shields.io/github/license/udx/worker-php.svg)](LICENSE)
 
-## 🚀 Overview
+PHP runtime image built on UDX Worker with NGINX + PHP-FPM preconfigured.
 
-The image is designed as a general-purpose base for PHP application development and deployment. It includes essential configurations for NGINX and PHP-FPM to streamline your setup, making it easy to get started with popular frameworks and custom applications alike.
+[Quick Start](#quick-start) • [Usage](#usage) • [Development](#development) • [Resources](#resources)
 
-### 🔧 Based on udx-worker
+## Overview
 
-Built on [`udx-worker`](https://github.com/udx/worker), this image benefits from secure, resource-efficient configurations and best practices, providing a reliable foundation for PHP applications.
+`udx-worker-php` extends [`udx/worker`](https://github.com/udx/worker) and keeps the same worker runtime model while adding:
 
-## 👨‍💻 Development
+- NGINX configured for `/var/www`
+- PHP-FPM (`8.4`) with socket-based NGINX integration
+- Worker service definitions that autostart both `php-fpm` and `nginx`
 
-### 📋 Prerequisites
+This image is intended as a base runtime for PHP applications and PHP-focused automation workloads.
 
-- Ensure `Docker` is installed and running on your system.
+## Quick Start
 
-### 🚀 Quick Start
+Requirements: Docker (and Make if you want local dev commands).
 
-This image serves as a base for your PHP applications. The `src/tests/` directory includes sample tests for verifying PHP and NGINX functionality, but it does not contain application code by default.
+### Run from Docker Hub
 
-### Running Built-In Tests
+```bash
+docker run -d \
+  --name my-php-app \
+  -p 80:80 \
+  -v "$(pwd)/my-php-app:/var/www" \
+  usabilitydynamics/udx-worker-php:latest
+```
 
-1. Clone this repository:
+Then open `http://localhost` (or your mapped host port).
 
-```
-git clone https://github.com/udx/udx-worker-php.git
-cd udx-worker-php
-```
+### Local Development Workflow
 
-2. Build the Docker image:
+```bash
+git clone https://github.com/udx/worker-php.git
+cd worker-php
 
-```
 make build
+make run
+make log FOLLOW_LOGS=true
 ```
 
-3. Run Tests to verify functionality:
-
-```
-make run-all-tests
-```
+`make run` uses these defaults from `Makefile.variables`:
 
-You can add additional tests in the `src/tests/` directory as needed.
+- volume: `./src/scripts:/var/www`
+- host/container port: `80:80`
+- env file: `.env`
 
-## 🚀 Deployment
+## Usage
 
-### Deploying Using the Pre-Built Image
+### Mount your own app code
 
-If you want to use the pre-built image directly from Docker Hub without cloning the repository:
+```bash
+make run VOLUMES="$(pwd)/path-to-app:/var/www" HOST_PORT=8080
+```
 
-1. Pull the Image:
+### Run interactively
 
-```
-docker pull usabilitydynamics/udx-worker-php:latest
+```bash
+make run-it
 ```
 
-2. Run the container with your application code:
+### Execute into the running container
 
-```
-docker run -d --name my-php-app \
-  -v $(pwd)/my-php-app:/var/www \
-  -p 80:80 \
-  usabilitydynamics/udx-worker-php:latest
+```bash
+make exec
 ```
 
-This serves your application at http://localhost.
+### Deploy with Worker CLI config
 
-3. Stop and remove the container when done:
+This repo includes a sample `deploy.yml` for [`@udx/worker-deployment`](https://www.npmjs.com/package/@udx/worker-deployment).
 
+```bash
+npm install -g @udx/worker-deployment
+worker run
 ```
-docker rm -f my-php-app
-```
-
-### Deploying Using a Locally Built Image (Makefile Approach)
 
-If you’ve cloned this repository and built the image locally, you can use the provided Makefile targets:
+## Testing
 
-1. Build the Image (if not already built):
+Run all built-in tests:
 
-```
-make build
+```bash
+make run-all-tests
 ```
 
-2. Run the Container:
+Run full validation (build + tests):
 
+```bash
+make test
 ```
-make run
-```
-
-By default, this command runs the container with the code located in the `src/` directory of this repository.
 
-3. Deploy Application Code. If your PHP application code is located in a different directory or repository, use the deploy target to mount it as a volume:
+Run a specific test script:
 
-```
-APP_PATH=/path/to/your-php-app make run
+```bash
+make run-test TEST_SCRIPT=10_nginx_test.php
 ```
 
-- Replace `/path/to/your-php-app` with the path to your PHP application directory.
-- This command will mount your specified application directory into the container’s `/var/www` directory, allowing you to run your custom application directly.
+Current tests live in `src/tests/` and cover:
 
-## ⚙️ Configuration
+- NGINX HTTP response
+- PHP runtime availability
+- CLI execution
+- write permissions under `/var/www`
 
-You can configure build and runtime variables in `Makefile.variables`:
+## Configuration
 
-- PHP and NGINX versions. _(Only PHP8.4 supported for now)_
-- Port mappings
-- Source paths
+Primary defaults are in `Makefile.variables`:
 
-Adjust these variables to suit your environment or specific deployment requirements.
+- `DOCKER_IMAGE`
+- `CONTAINER_NAME`
+- `HOST_PORT` / `CONTAINER_PORT`
+- `VOLUMES`
+- `PHP_VERSION`
 
-## 🛠️ Makefile Commands Helper
+Container/runtime config files:
 
-Use make to view all available commands:
+- `etc/configs/nginx/default.conf`
+- `etc/configs/php/php-fpm.conf`
+- `etc/configs/php/www.conf`
+- `etc/configs/worker/services.yaml`
 
-```
+## Development
+
+Useful commands:
+
+```bash
 make help
+make build
+make run
+make log
+make clean
+make test
 ```
 
-These commands offer options for building, running, and testing your application seamlessly.
+## Resources
+
+- Docker Hub: https://hub.docker.com/r/usabilitydynamics/udx-worker-php
+- Source: https://github.com/udx/worker-php
+- Base runtime docs: https://github.com/udx/worker/tree/latest/docs
+- Deployment config docs: https://github.com/udx/worker-deployment/blob/latest/docs/deploy-config.md
 
-## 🤝 Contributing
-We welcome contributions! Here's how you can help:
+## Contributing
 
 1. Fork the repository
 2. Create a feature branch
 3. Commit your changes
 4. Push to your branch
-5. Open a Pull Request
-
-Please ensure your PR:
-- Follows our coding standards
-- Includes appropriate tests
-- Updates relevant documentation
-
-## 🔗 Resources
-- [Docker Hub](https://hub.docker.com/r/usabilitydynamics/udx-worker-php)
-- [Product Page](https://udx.io/products/udx-worker-php)
+5. Open a pull request
 
-## 🎯 Custom Development
-Need specific features or customizations?
-[Contact our team](https://udx.io/) for professional development services.
+Include relevant tests and documentation updates with your changes.
 
-## 📄 License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+## License
 
----
-<div align="center">
-Built by <a href="https://udx.io">UDX</a> © 2025
-</div>
+MIT. See [`LICENSE`](LICENSE).