From c135beee017bc778b62f7252ff74ecfe4a441039 Mon Sep 17 00:00:00 2001 From: Tim Nolte Date: Tue, 9 Apr 2024 08:50:40 -0400 Subject: [PATCH] fix(README): Updates the README with supported tags (#44) - Updates the README with supported tags and usage details. - Rebuilds images with latest PHP & NodeJS versions. --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2cee730..e64ac9a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# wp-dev-container +# WP Dev Container + +[![Release Status](https://github.com/ndigitals/wp-dev-container/actions/workflows/release-build.yml/badge.svg?branch=main)](https://github.com/ndigitals/wp-dev-container/actions/workflows/release-build.yml) + WordPress Plugin & Theme Dev Container + +## Supported tags + +- `php-8.3-node-20`, `php-8.3-node-18`, `php-8.3-node-16` +- `php-8.2-node-20`, `php-8.2-node-18`, `php-8.2-node-16` +- `php-8.1-node-20`, `php-8.1-node-18`, `php-8.1-node-16` +- `php-8.0-node-20`, `php-8.0-node-18`, `php-8.0-node-16` + +## Prerequisites + +- [Install Docker](https://www.docker.com/) + +## Usage + +### Download an image + +Download the WP Dev Container image, choose a tag for the PHP & NodeJS version you need. + +```shell +docker pull docker pull ghcr.io/ndigitals/wp-dev-container:php-8.2-node-20 +``` + +## NodeJS Support + +This image includes NodeJS in order to run NodeJS apps. Choose a tag that includes the version of NodeJS needed. + +## Support & Feedback + +If you still have a question after using OpenLiteSpeed Docker, you have a few options. + +- Reporting any issue on [Github wp-dev-container](https://github.com/ndigitals/wp-dev-container/issues) project + +**Pull requests are always welcome**