Skip to content

Commit c53e417

Browse files
authored
πŸ“ Improve README (#51)
1 parent 9451af4 commit c53e417

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</a>
1919
</p>
2020

21-
<p align="center">Composer package for installing WordPress</p>
21+
<p align="center">Meta-package for installing WordPress via Composer</p>
2222

2323
<p align="center">
2424
<a href="https://roots.io/composer-wordpress-resources/">Website</a> &nbsp;&nbsp; <a href="https://packagist.org/packages/roots/wordpress">Packages</a> &nbsp;&nbsp; <a href="https://github.com/roots/wordpress/releases">Releases</a> &nbsp;&nbsp; <a href="https://discourse.roots.io/">Community</a>
@@ -30,11 +30,30 @@ Roots is an open source project and completely free to use. If you've benefited
3030

3131
## Overview
3232

33-
`roots/wordpress` is an automatically updated Composer package for WordPress core.
33+
`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:
34+
35+
Package|Description|Content
36+
--|--|--
37+
[`roots/wordpress`](https://github.com/roots/wordpress)|Meta-package (this package)|Installs `roots/wordpress-no-content`
38+
[`roots/wordpress-full`](https://github.com/roots/wordpress-full)|Full WordPress build|βœ… Core<br>βœ… Official themes<br>βœ… Akismet & Hello Dolly<br>βœ… Beta & RC releases
39+
[`roots/wordpress-no-content`](https://github.com/roots/wordpress-no-content)|Minimal WordPress build|βœ… Core only<br>❌ No themes or plugins<br>❌ No beta releases
40+
[`roots/wordpress-packager`](https://github.com/roots/wordpress-packager)|Build tooling|Creates the package releases
41+
42+
## Requirements
43+
44+
A [WordPress Core Installer](https://packagist.org/?query=wordpress%20core%20installer&type=composer-plugin) package is required to handle installation path.
45+
46+
> [!tip]
47+
> Roots project provides a core installer, `roots/wordpress-core-installer`.
48+
> See the [usage docs](https://github.com/roots/wordpress-core-installer#readme).
3449
3550
## Getting Started
3651

37-
See the [Composer with WordPress Resources introduction](https://roots.io/composer-wordpress-resources/).
52+
```console
53+
composer require roots/wordpress
54+
```
55+
56+
For more detailed information and examples, see the [Composer with WordPress Resources introduction](https://roots.io/composer-wordpress-resources/).
3857

3958
## Stay Connected
4059

0 commit comments

Comments
Β (0)