diff --git a/README.md b/README.md index 758eddd..747abfc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ -# wordPress-stack-with-xdebug +# WordPress stack with xdebug + +A handy WordPress stack using docker compose with PHP xdebug enabled. + +## Preparation and Start + +Before starting the stack, please prepare the .env file. There is a sample .env file `sample.env` for the reference. + +To start the stack, type: + +``` +docker-compose up -d +``` + +## About the XDebug +The XDebug feature is based on this online information: +https://marioyepes.com/setup-debug-php-docker-visual-studio-code + -A handy WordPress stack using docker compose with xdebug enabled. \ No newline at end of file