Update README.md

Automattic · Feb 29, 2024 · 733339d · 733339d
1 parent 322c224
commit 733339d
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
 # githubdeployments-composer-example
-An example plugin repository with a workflow script that install Composer dependencies
+An example plugin repository with a workflow script that install Composer dependencies. 
+
+The [workflow](.github/workflows/wpcom.yml) does the following:
+
+1. Checkout the repository
+2. Run `composer install` which is the default behaviour of the [Composer Action](https://github.com/php-actions/composer). 
+3. Create a build artifact with name `wpcom` which is required for WordPress.com's GitHub Deployment feature
+