aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-16 23:56:50 -0700
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-16 23:56:50 -0700
commit6bb0c03d8ddfd18fe1e8dbe060a61a691681e631 (patch)
tree89cd50d1939fdb47e6b4e1da8235635584f09d20
parent797c94b0e9fdfb9c5d9a6f94687970af2faf856a (diff)
downloadbun-6bb0c03d8ddfd18fe1e8dbe060a61a691681e631.tar.gz
bun-6bb0c03d8ddfd18fe1e8dbe060a61a691681e631.tar.zst
bun-6bb0c03d8ddfd18fe1e8dbe060a61a691681e631.zip
Update README.md
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7e8f6e8dd..dc606cf48 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ npm install -g bun-cli
## Using Bun with Next.js
-In your project folder root (where `package.json` is):
+To create a new Next.js app with Bun:
```bash
bun create next ./app
@@ -36,6 +36,14 @@ cd app
bun
```
+To use an existing Next.js app with Bun:
+
+```bash
+npm install bun-framework-next
+bun bun --use next
+bun
+```
+
Many of Next.js' features are supported, but not all.
Here's what doesn't work yet:
@@ -77,7 +85,7 @@ If `public/index.html` exists, it becomes the default page instead of a 404 page
#### Using Bun with Create React App
-Run this:
+To create new a React app:
```bash
bun create react ./app
@@ -85,6 +93,13 @@ cd app
bun
```
+To use an existing React app:
+
+```bash
+bun create /absolute-path-to-react-app app
+bun
+```
+
From there, Bun relies on the filesystem for mapping dev server paths to source files. All URL paths are relative to the project root (where `package.json` is located).
Here are examples of routing source code file paths: