aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-14 19:17:20 -0700
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-14 19:17:20 -0700
commit9dfe57a3f79004f8f2e06bb21344f0c2bfeaa32a (patch)
tree0d1b48e6dabe3444863a16302916028433989693
parentf10dcd780cdcfc91e67223bb91c6e14605a27453 (diff)
downloadbun-9dfe57a3f79004f8f2e06bb21344f0c2bfeaa32a.tar.gz
bun-9dfe57a3f79004f8f2e06bb21344f0c2bfeaa32a.tar.zst
bun-9dfe57a3f79004f8f2e06bb21344f0c2bfeaa32a.zip
Update README.md
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0a29fb98c..a57b485e6 100644
--- a/README.md
+++ b/README.md
@@ -426,7 +426,7 @@ By default, templates are downloaded from folders inside `examples/` in Bun's Gi
Create a new Next.js project:
```bash
-bun create next ./app`
+bun create next ./app
```
Create a new React project:
@@ -455,10 +455,17 @@ Before checking Bun's examples folder, `bun create` checks for a local folder ma
If a folder exists in any of those folders with the input, bun will use that instead of a remote template.
+To create a local template, run:
+
+```bash
+mkdir -p $HOME/.bun-create/new-template-name
+echo '{"name":"new-template-name"}' > $HOME/.bun-create/new-template-name/package.json
+```
+
This lets you run:
```bash
-bun create my-boilerplate ./app
+bun create new-template-name ./app
```
Now your new template should appear when you run: