Skip to content

Commit 5ef8f92

Browse files
author
Dmitry Smirnov
committed
readme update
1 parent 762b98f commit 5ef8f92

File tree

1 file changed

+44
-10
lines changed

1 file changed

+44
-10
lines changed

README.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
# UDX Worker PHP
22

3-
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.
3+
[![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)
44

5-
## Overview
5+
**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.**
6+
7+
[Quick Start](#-quick-start)[Development](#-development)[Deployment](#-deployment)[Contributing](#-contributing)
8+
9+
## 🚀 Overview
610

711
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.
812

9-
### Based on udx-worker
13+
### 🔧 Based on udx-worker
1014

11-
Built on `udx-worker`, this image benefits from secure, resource-efficient configurations and best practices, providing a reliable foundation for PHP applications.
15+
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.
1216

13-
## Development
17+
## 👨‍💻 Development
1418

15-
### Prerequisites
19+
### 📋 Prerequisites
1620

1721
- Ensure `Docker` is installed and running on your system.
1822

19-
### Quick Start
23+
### 🚀 Quick Start
2024

2125
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.
2226

@@ -43,7 +47,7 @@ make run-all-tests
4347

4448
You can add additional tests in the `src/tests/` directory as needed.
4549

46-
## Deployment
50+
## 🚀 Deployment
4751

4852
### Deploying Using the Pre-Built Image
4953

@@ -99,7 +103,7 @@ APP_PATH=/path/to/your-php-app make run
99103
- Replace `/path/to/your-php-app` with the path to your PHP application directory.
100104
- This command will mount your specified application directory into the container’s `/var/www` directory, allowing you to run your custom application directly.
101105

102-
## Configuration
106+
## ⚙️ Configuration
103107

104108
You can configure build and runtime variables in `Makefile.variables`:
105109

@@ -109,7 +113,7 @@ You can configure build and runtime variables in `Makefile.variables`:
109113

110114
Adjust these variables to suit your environment or specific deployment requirements.
111115

112-
## Makefile Commands Helper
116+
## 🛠️ Makefile Commands Helper
113117

114118
Use make to view all available commands:
115119

@@ -118,3 +122,33 @@ make help
118122
```
119123

120124
These commands offer options for building, running, and testing your application seamlessly.
125+
126+
## 🤝 Contributing
127+
We welcome contributions! Here's how you can help:
128+
129+
1. Fork the repository
130+
2. Create a feature branch
131+
3. Commit your changes
132+
4. Push to your branch
133+
5. Open a Pull Request
134+
135+
Please ensure your PR:
136+
- Follows our coding standards
137+
- Includes appropriate tests
138+
- Updates relevant documentation
139+
140+
## 🔗 Resources
141+
- [Docker Hub](https://hub.docker.com/r/usabilitydynamics/udx-worker-php)
142+
- [Product Page](https://udx.io/products/udx-worker-php)
143+
144+
## 🎯 Custom Development
145+
Need specific features or customizations?
146+
[Contact our team](https://udx.io/) for professional development services.
147+
148+
## 📄 License
149+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
150+
151+
---
152+
<div align="center">
153+
Built with ❤️ by <a href="https://udx.io">UDX</a>
154+
</div>

0 commit comments

Comments
 (0)