feat(init): generate README

webpack · May 28, 2019 · c090b17 · c090b17
1 parent 25ab7e6
commit c090b17
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git 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
@@ -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