aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-26 17:12:22 -0700
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-10-26 17:12:22 -0700
commit79eb8d9d78a5ddc42b83c2044b0049474a26f3ae (patch)
treef65c0161a1748b4d6213d6231a718a75e9392b0c /README.md
parent221b280856068aad1f1886c006f28e8900236d4a (diff)
downloadbun-79eb8d9d78a5ddc42b83c2044b0049474a26f3ae.tar.gz
bun-79eb8d9d78a5ddc42b83c2044b0049474a26f3ae.tar.zst
bun-79eb8d9d78a5ddc42b83c2044b0049474a26f3ae.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/README.md b/README.md
index 968e3f73f..7673bb81e 100644
--- a/README.md
+++ b/README.md
@@ -24,15 +24,21 @@ npm install -g bun-cli
**JavaScript**: TODO
-### Getting started
-
## Using Bun as a task runner
Instead of waiting 170ms for your npm client to start for each task, you wait 6ms for Bun.
To use bun as a task runner, run `bun run` instead of `npm run`.
-A package.json that looks like this:
+```bash
+# Instead of "npm run clean"
+bun run clean
+
+# This also works
+bun clean
+```
+
+Assuming a package.json with a `clean` command in `scripts`:
```json
{
@@ -43,15 +49,6 @@ A package.json that looks like this:
}
```
-Can run:
-
-```bash
-bun run clean
-
-# This also works
-bun clean
-```
-
## Using Bun with Next.js
To create a new Next.js app with Bun: