From 86533d871412b38f765b615a6c3ade7ff69e1f62 Mon Sep 17 00:00:00 2001
From: Haoqun Jiang <haoqunjiang@gmail.com>
Date: Tue, 10 Aug 2021 16:21:39 +0800
Subject: [PATCH] chore: add `NPM-SCRIPTS-PLACEHOLDER` in README

---
 index.js                       | 3 ++-
 template/config/base/README.md | 6 +++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/index.js b/index.js
index 7a39bdaa..07ee09df 100755
--- a/index.js
+++ b/index.js
@@ -214,7 +214,8 @@ async function init() {
     (isSPA ? 'spa' : 'default')
   render(`code/${codeTemplate}`)
 
-  // TODO: README generation
+  // TODO:
+  // Replace `<!-- NPM-SCRIPTS-PLACEHOLDER -->` in README with detailed explanation of npm scripts.
 
   // Cleanup.
 
diff --git a/template/config/base/README.md b/template/config/base/README.md
index 0c089225..c3a42c19 100644
--- a/template/config/base/README.md
+++ b/template/config/base/README.md
@@ -12,6 +12,10 @@ Since TypeScript cannot handle type information for `.vue` imports, they are shi
 
 However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette.
 
-### Customize configuration
+## Customize configuration
 
 See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Usage
+
+<!-- NPM-SCRIPTS-PLACEHOLDER -->
-- 
2.39.5