diff --git a/.readme-partials/disclaimer.md b/.readme-partials/disclaimer.md new file mode 100644 index 00000000..f4a15d61 --- /dev/null +++ b/.readme-partials/disclaimer.md @@ -0,0 +1,2 @@ +> [!NOTE] +> Scaffolding plugins and themes with `wp scaffold` is no longer recommended for modern WordPress development. Newer tools like [`@wordpress/create-block`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/) provide up-to-date build configurations and block theme support. diff --git a/README.md b/README.md index 9d2f0027..99d5c429 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ wp-cli/scaffold-command Generates code for post types, taxonomies, blocks, plugins, child themes, etc. +> [!NOTE] +> Scaffolding plugins and themes with `wp scaffold` is no longer recommended for modern WordPress development. Newer tools like [`@wordpress/create-block`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/) provide up-to-date build configurations and block theme support. + [![Testing](https://github.com/wp-cli/scaffold-command/actions/workflows/testing.yml/badge.svg)](https://github.com/wp-cli/scaffold-command/actions/workflows/testing.yml) [![Code Coverage](https://codecov.io/gh/wp-cli/scaffold-command/branch/main/graph/badge.svg)](https://codecov.io/gh/wp-cli/scaffold-command/tree/main) Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support) diff --git a/composer.json b/composer.json index ca135714..f9238d4a 100644 --- a/composer.json +++ b/composer.json @@ -43,7 +43,12 @@ "scaffold post-type", "scaffold taxonomy", "scaffold theme-tests" - ] + ], + "readme": { + "package_description": { + "post": ".readme-partials/disclaimer.md" + } + } }, "autoload": { "classmap": [