Feature: Installer Script

.phpcs.xml

@@ -32,4 +32,14 @@
 
   <!-- The version set here matches the minimum version tested in CI. -->
   <config name="minimum_supported_wp_version" value="6.2" />
+
+  <!-- Define the prefixes that can be used by the plugin -->
+  <rule ref="WordPress.NamingConventions.PrefixAllGlobals">
+    <properties>
+      <property name="prefixes" type="array">
+        <element value="vendor_name" />
+        <element value="create_wordpress_project" />
+      </property>
+    </properties>
+  </rule>
 </ruleset>

Makefile

@@ -0,0 +1,4 @@
+setup:
+	php ./configure.php
+
+.PHONY: setup

README.md

@@ -1,2 +1,46 @@
+<!--delete-->
+# Create WordPress Project
+
+This is a skeleton WordPress project that can be used to quickly scaffold
+WordPress projects that work with Alley's
+[create-wordpress-plugin](https://github.com/alleyinteractive/create-wordpress-plugin)
+and
+[create-wordpress-theme](https://github.com/alleyinteractive/create-wordpress-theme)
+starter kits.
+
+This template is rooted at the `wp-content` and supports both Pantheon and
+WordPress VIP hosting environments with deployment workflows for each. It is
+powered by [Composer](https://getcomposer.org/) to manage dependencies and
+[Turborepo](https://turbo.build/repo) to build front-end assets in your project. The template includes both GitHub Actions and Buddy workflows for continuous integration and deployment.
+
+Also included is a configuration script to easily replace all placeholders throughout the project and scaffold out your plugin/theme.
+
+## Getting Started
+
+Follow these steps to get started:
+
+1. Press the "Use template" button at the top of this repo to create a new repo
+   with the contents of this skeleton.
+2. Run `make` (or `php ./configure.php`) to run the configuration script that
+   will replace all placeholders throughout all the files.
+3. Have fun creating your WordPress site! 🎊
+
+<!--/delete-->
+
 # create-wordpress-project
-A starter structure for the wp-content directory on a new WordPress project.
+
+A skeleton for WordPress projects rooted at `wp-content` using Alley's best
+practices for WordPress development.
+
+## Credits
+
+This project is actively maintained by [Alley
+Interactive](https://github.com/alleyinteractive). Like what you see? [Come work
+with us](https://alley.com/careers/).
+
+- [author_name](https://github.com/author_name)
+- [All Contributors](../../contributors)
+
+## License
+
+The GNU General Public License (GPL) license. Please see [License File](LICENSE) for more information.

composer.json

@@ -1,10 +1,41 @@
 {
+  "name": "alleyinteractive/create-wordpress-project",
+  "description": "A skeleton WordPress project",
+  "license": "GPL-2.0-or-later",
+  "type": "project",
+  "keywords": [
+    "alleyinteractive",
+    "create-wordpress-project"
+  ],
   "authors": [
     {
       "name": "Alley",
       "email": "[email protected]"
     }
   ],
+  "homepage": "https://github.com/alleyinteractive/create-wordpress-project",
+  "require": {
+    "php": "^8.2",
+    "alleyinteractive/composer-wordpress-autoloader": "^1.0",
+    "composer/installers": "^1.0",
+    "pantheon-systems/pantheon-mu-plugin": "^1.0"
+  },
+  "require-dev": {
+    "alleyinteractive/alley-coding-standards": "^2.0",
+    "mantle-framework/testkit": "^0.12",
+    "szepeviktor/phpstan-wordpress": "^1.1"
+  },
+  "repositories": [
+    {
+      "type": "composer",
+      "url": "https://wpackagist.org",
+      "only": [
+        "wpackagist-plugin/*"
+      ]
+    }
+  ],
+  "minimum-stability": "dev",
+  "prefer-stable": true,
   "config": {
     "allow-plugins": {
       "alleyinteractive/composer-wordpress-autoloader": true,
@@ -14,7 +45,6 @@
     },
     "sort-packages": true
   },
-  "description": "A skeleton WordPress project",
   "extra": {
     "installer-paths": {
       "mu-plugins/{$name}": [
@@ -33,35 +63,6 @@
       }
     }
   },
-  "homepage": "https://github.com/alleyinteractive/create-wordpress-project",
-  "keywords": [
-    "alleyinteractive",
-    "create-wordpress-project"
-  ],
-  "license": "GPL-2.0-or-later",
-  "minimum-stability": "dev",
-  "name": "alleyinteractive/create-wordpress-project",
-  "prefer-stable": true,
-  "repositories": [
-    {
-      "type": "composer",
-      "url": "https://wpackagist.org",
-      "only": [
-        "wpackagist-plugin/*"
-      ]
-    }
-  ],
-  "require": {
-    "alleyinteractive/composer-wordpress-autoloader": "^1.0",
-    "composer/installers": "^1.0",
-    "pantheon-systems/pantheon-mu-plugin": "^1.0",
-    "php": "^8.0"
-  },
-  "require-dev": {
-    "alleyinteractive/alley-coding-standards": "^1.0",
-    "mantle-framework/testkit": "^0.11",
-    "szepeviktor/phpstan-wordpress": "^1.1"
-  },
   "scripts": {
     "phpcbf": [
       "@phpcbf:plugin",
@@ -75,13 +76,13 @@
     ],
     "phpcs:plugin": "cd plugins/create-wordpress-plugin && phpcs .",
     "phpcs:theme": "cd themes/create-wordpress-theme && phpcs .",
+    "phpstan": "phpstan --memory-limit=512M",
     "phpunit": [
       "@phpunit:plugin",
       "@phpunit:theme"
     ],
     "phpunit:plugin": "cd plugins/create-wordpress-plugin && phpunit",
     "phpunit:theme": "cd themes/create-wordpress-theme && phpunit",
-    "phpstan": "phpstan --memory-limit=512M",
     "setup": [
       "composer install --quiet --no-interaction"
     ],
@@ -90,6 +91,5 @@
       "@phpstan",
       "@phpunit"
     ]
-  },
-  "type": "project"
+  }
 }