Merge pull request #321 from wpengine/chore-add-docs-for-composer-installs

docs: Created docs on how to install plugins.

Author: colinmurphy

docs/README.md

@@ -18,6 +18,7 @@
 | Title                              | Description                  |
 |------------------------------------|------------------------------|
 | [Automatic Persisted Queries in Next.js Pages Router](how-to/nextjs-pages-router/enable-apq/index.md) | Learn how to reduce latency and network strain in GraphQL queries using Automatic Persisted Queries (APQ) by hashing and reusing query hashes. |
+| [Install Toolkit Plugins via Composer](how-to/install-toolkit-plugins/index.md) | Step-by-step guide to installing and activating HWP Toolkit plugins in your WordPress environment using Composer. |
 
 
 ## Contributing

docs/how-to/install-toolkit-plugins/index.md

@@ -0,0 +1,75 @@
+# Installing HWP Toolkit Plugins with Composer
+
+You can install any HWP Toolkit plugin using Composer, which is the recommended way for modern WordPress development workflows.
+
+You can also install them manually from our [Releases](https://github.com/wpengine/hwptoolkit/releases) page.
+
+## Requirements
+
+- Composer 1.x or 2.x
+- WordPress 6.0+
+- PHP 7.4+
+
+## Quick Start: Example `composer.json`
+
+Copy and use this example as your `composer.json` for a typical WordPress project using HWP Toolkit plugins:
+
+```json
+{
+  "name": "wpengine/headless-wordpress-toolkit-composer-test",
+  "description": "Headless WordPress Toolkit Composer Test",
+  "repositories": [
+    {
+      "type": "composer",
+      "url": "https://raw.githubusercontent.com/wpengine/hwptoolkit/main/plugins/composer-packages.json"
+    }
+  ],
+  "require": {
+    "wpengine/hwp-previews": "*",
+    "wpengine/wp-graphql-webhooks": "*"
+  },
+  "config": {
+    "allow-plugins": {
+      "composer/installers": true
+    }
+  }
+}
+```
+
+## Installation Steps
+
+1. **Copy the above JSON into your project's `composer.json` file.**
+
+2. **Install dependencies:**
+
+   ```bash
+   composer install
+   ```
+
+3. **Activate the plugin(s) in WordPress**
+
+   Go to the WordPress admin and activate the plugin(s) as usual.
+
+---
+
+## Updating
+
+To update to the latest version:
+
+```bash
+composer update wpengine/hwp-previews wpengine/wp-graphql-webhooks
+```
+
+---
+
+## Troubleshooting
+
+- If you see an error about missing `composer/installers`, run `composer require composer/installers`.
+- If the plugin does not appear in your plugins list, check your `installer-paths` and that you are in the correct WordPress directory.
+- Ensure the `repositories` section is present and correct in your `composer.json`.
+
+---
+
+## Contributing
+
+If you feel like something is missing or you want to add documentation, we encourage you to contribute! Please check out our [Contributing Guide](https://github.com/wpengine/hwptoolkit/blob/main/CONTRIBUTING.md) for more details.

plugins/README.md

@@ -10,6 +10,17 @@ WordPress plugins for the Headless WordPress Toolkit. Each plugin is paired with
 | [`wp-graphql-webhooks`](./wp-graphql-webhooks/README.md) | A WordPress plugin that extends [WPGraphQL](https://www.wpgraphql.com/) to support webhook subscriptions and dispatching for headless WordPress environments. This allows external applications to listen and respond to WordPress content changes through GraphQL-driven webhook events. |
 
 
+## Install
+
+You can install HWP Toolkit plugins in two ways:
+
+- **Using Composer:** Follow the [step-by-step guide](../docs/how-to/install-toolkit-plugins/index.md) to install and activate plugins in your WordPress environment.
+- **Manual Download:** Visit the [Releases](https://github.com/wpengine/hwptoolkit/releases) page to manually download the plugin files and upload them to your WordPress site.
+
+
+>[!NOTE]
+> The main composer packages file [composer-packages.json](composer-packages.json) is automatically updated as part our release workflow.
+
 ## Contributing
 
 If you feel like something is missing or you want to add documentation, we encourage you to contribute! Please check out our [Contributing Guide](https://github.com/wpengine/hwptoolkit/blob/main/CONTRIBUTING.md) for more details.