Skip to content

Commit 3000bf3

Browse files
committed
chore: adding README in the sample project
1 parent 2fb90cf commit 3000bf3

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/commands/default.ts

+16
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,22 @@ export default class CreateStoryblokAppCommand extends Command {
164164

165165
fs.rmSync(`./temp-started/${framework}/.git`, {recursive: true})
166166

167+
const readmeContent = `
168+
# Storyblok quick starter project
169+
170+
Welcome to this sample project for ${frameworkDetails.name}!
171+
This project serves as a quick starter for integrating Storyblok, a headless CMS, into your web development projects.
172+
173+
For starting, you can access to the \`${folder}\` folder.
174+
In the folder you have some files like:
175+
176+
- \`${frameworkDetails.config}\`: the configuration with Storyblok API;
177+
- \`${frameworkDetails.bridge}\`: the initialization of the Storyblok Bridge.
178+
179+
`
180+
fs.rmSync(`./temp-started/${framework}/README.md`)
181+
fs.writeFileSync(`./temp-started/${framework}/README.md`, readmeContent)
182+
167183
copy(`./temp-started/${framework}`, folder)
168184
directoryTargetCreated = true
169185
fs.rmSync('./temp-started', {recursive: true})

0 commit comments

Comments
 (0)