diff --git a/README.md b/README.md index 23cd7eb..1a696aa 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@
-Composer package for installing WordPress
+Meta-package for installing WordPress via Composer
Website Packages Releases Community
@@ -30,11 +30,30 @@ Roots is an open source project and completely free to use. If you've benefited
## Overview
-`roots/wordpress` is an automatically updated Composer package for WordPress core.
+`roots/wordpress` is a meta-package that provides WordPress core installation via Composer. It's part of the Roots WordPress packaging ecosystem, which includes several packages to give you flexibility in how WordPress is installed:
+
+Package|Description|Content
+--|--|--
+[`roots/wordpress`](https://github.com/roots/wordpress)|Meta-package (this package)|Installs `roots/wordpress-no-content`
+[`roots/wordpress-full`](https://github.com/roots/wordpress-full)|Full WordPress build|✅ Core
✅ Official themes
✅ Akismet & Hello Dolly
✅ Beta & RC releases
+[`roots/wordpress-no-content`](https://github.com/roots/wordpress-no-content)|Minimal WordPress build|✅ Core only
❌ No themes or plugins
❌ No beta releases
+[`roots/wordpress-packager`](https://github.com/roots/wordpress-packager)|Build tooling|Creates the package releases
+
+## Requirements
+
+A [WordPress Core Installer](https://packagist.org/?query=wordpress%20core%20installer&type=composer-plugin) package is required to handle installation path.
+
+> [!tip]
+> Roots project provides a core installer, `roots/wordpress-core-installer`.
+> See the [usage docs](https://github.com/roots/wordpress-core-installer#readme).
## Getting Started
-See the [Composer with WordPress Resources introduction](https://roots.io/composer-wordpress-resources/).
+```console
+composer require roots/wordpress
+```
+
+For more detailed information and examples, see the [Composer with WordPress Resources introduction](https://roots.io/composer-wordpress-resources/).
## Stay Connected