diff --git a/packages/generators/init-generator.ts b/packages/generators/init-generator.ts index 29428aed471..ebe49ee6c13 100644 --- a/packages/generators/init-generator.ts +++ b/packages/generators/init-generator.ts @@ -291,6 +291,13 @@ export default class InitGenerator extends Generator { ); } + // Generate README + this.fs.copyTpl( + path.resolve(__dirname, "./templates/README.md"), + this.destinationPath("README.md") + ); + + // Genrate tsconfig if (this.langType === LangType.Typescript) { const tsConfigTemplatePath = "./templates/tsconfig.json.js"; this.fs.extendJSON(this.destinationPath("tsconfig.json"), require(tsConfigTemplatePath)); diff --git a/packages/generators/templates/README.md b/packages/generators/templates/README.md new file mode 100644 index 00000000000..92053bba6ec --- /dev/null +++ b/packages/generators/templates/README.md @@ -0,0 +1,15 @@ +# 🚀 Welcome to your new awesome project! + +This project has been created using **webpack scaffold**, you can now run + +``` +npm run build +``` + +or + +``` +yarn build +``` + +to bundle your application