From 2dfad9b5db39a88fbe221605e7bc9708c3d82b4b Mon Sep 17 00:00:00 2001 From: Greg Boggs Date: Thu, 10 Jun 2021 12:41:40 -0700 Subject: [PATCH] Give the project template a unique name space, a description, and an example command to start a new project from the template --- README.md | 8 ++++++++ composer.json | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d530d859..ad9158e2 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,14 @@ Drupal is a flexible and extensible PHP-based CMS framework. Run through the Drupal installer as normal. You will not be asked for database credentials as those are already provided. +## Create a new project locally with Composer + +This Composer command will create a new Drupal 9 project locally from this template with the customizations you need to deploy your project to Platform.sh. + +``` +composer create-project platformsh/drupal-recommended-project +``` + ## Customizations The following changes have been made relative to Drupal 9 "Recommended" project as it is downloaded from Drupal.org or Packagist. If using this project as a reference for your own existing project, replicate the changes below to your project. diff --git a/composer.json b/composer.json index 915a8aab..257d657e 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { - "name": "drupal/recommended-project", - "description": "Project template for Drupal 9 projects with a relocated document root", + "name": "platformsh/drupal-recommended-project", + "description": "This template builds Drupal 9 for Platform.sh based the \"Drupal Recommended\" Composer project.", "type": "project", "license": "GPL-2.0-or-later", "homepage": "https://www.drupal.org/project/drupal",