Enhance README

README.md

@@ -1,28 +1,32 @@
-# Starter
+# Comet DXP Starter
 
-# Development
+In use by `@comet/create-app` to create new Comet DXP projects. Find more information in the [Comet DXP documentation](https://docs.comet-dxp.com).
 
-## Requirements
+<!-- PROJECT_README_BEGIN Everything below this line will go into the Readme of projects created by @comet/create-app -->
+
+## Development
+
+### Requirements
 
 -   [nvm](https://github.com/nvm-sh/nvm)
 -   [docker & docker-compose](https://docs.docker.com/compose/)
 
-## Installation
+### Installation
 
     // Optionally set domain to use instead of localhost (add to ~/.bashrc)
     export DEV_DOMAIN=myname.dev.vivid-planet.cloud // Vivid Planet network
 
     // Execute following script
     ./install.sh
 
-## Uninstallation
+### Uninstallation
 
     // Removes docker volumes and all files and folder which are not managed in the repo (node_modules, lib,...)
     // If you want to reset your development environment totally, run this command and ./install.sh afterwards.
 
     ./uninstall.sh
 
-## Run Services
+### Run Services
 
     // use correct npm version https://github.com/nvm-sh/nvm#deeper-shell-integration
     nvm use

create-app/src/scripts/create-app/cleanupReadme.ts

@@ -0,0 +1,9 @@
+import * as fs from "fs";
+
+const readmePath = "README.md";
+
+export function cleanupReadme() {
+    const originalReadme = fs.readFileSync(readmePath, "utf8").toString();
+    const newReadme = originalReadme.replace(/.+<!-- PROJECT_README_BEGIN.+-->\n\n/s, "");
+    fs.writeFileSync(readmePath, newReadme, "utf8");
+}

create-app/src/scripts/create-app/createApp.ts

@@ -2,6 +2,7 @@ import kleur from "kleur";
 import process from "process";
 
 import { replacePlaceholder } from "../../util/replacePlaceholder";
+import { cleanupReadme } from "./cleanupReadme";
 import { cleanupWorkingDirectory } from "./cleanupWorkingDirectory";
 import { createInitialGitCommit } from "./createInitialGitCommit";
 import { createWorkingDirectoryCopy } from "./createWorkingDirectoryCopy";
@@ -16,6 +17,7 @@ export async function createApp(projectConfiguration: ProjectConfiguration) {
     if (!createWorkingDirectoryCopy(projectConfiguration.projectName, projectConfiguration.verbose)) {
         return;
     }
+    cleanupReadme();
     cleanupWorkingDirectory(projectConfiguration.verbose);
     replacePlaceholder(projectConfiguration.projectName, projectConfiguration.verbose);
     createInitialGitCommit();