Skip to content

Commit c22417d

Browse files
committed
Note examples as experimental
1 parent 513cede commit c22417d

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ npx create-stackbit-app --starter ts-nextjs
3333

3434
If no starter option is provided, [the default starter](https://github.com/stackbit-themes/nextjs-starter) is used.
3535

36-
### Starting from an Example
36+
### Starting from an Example (🧪 Experimental)
3737

3838
Use the `--example` option to start a project from an example. Run the command with the `--help` flag to see a full list of available starters.
3939

@@ -43,6 +43,8 @@ npx create-stackbit-app --example algolia-search
4343

4444
This will create a new project matching the name of the example, unless overridden (see below). [See here for a full list of starters](https://github.com/stackbit-themes/stackbit-examples).
4545

46+
_Note: This is an experimental feature. Please [report issues](https://github.com/stackbit/create-stackbit-app/issues/new)._
47+
4648
### Setting Project Directory
4749

4850
Pass a directory name as the only argument when running the command. For example, if you wanted your directory to be name `my-site`, the command would look something like this:

index.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,10 @@ async function cloneExample() {
133133
if (!gitVersionMatch || !gitVersionMatch[0]) {
134134
console.error(
135135
`Cannot determine git version, which is required for starting from an example.`,
136-
`\nPlease report this to ${chalk.underline("support@stackbit.com")}.`
136+
`\nPlease report this:`,
137+
chalk.underline(
138+
"https://github.com/stackbit/create-stackbit-app/issues/new"
139+
)
137140
);
138141
process.exit(1);
139142
}

0 commit comments

Comments
 (0)