diff options
author | 2021-09-05 19:41:08 -0700 | |
---|---|---|
committer | 2021-09-05 19:41:08 -0700 | |
commit | cd69063660ed24ea31447006319343fe841fd147 (patch) | |
tree | 738b3755ef5263ea55a2805c764a72d7005e1dc1 | |
parent | 0822e67594211850b9e21c8860594a13737f95cb (diff) | |
download | bun-cd69063660ed24ea31447006319343fe841fd147.tar.gz bun-cd69063660ed24ea31447006319343fe841fd147.tar.zst bun-cd69063660ed24ea31447006319343fe841fd147.zip |
Update README.md
Former-commit-id: 74973a4535244c65269247334b59ae6d7d3598ea
-rw-r--r-- | README.md | 18 |
1 files changed, 12 insertions, 6 deletions
@@ -7,7 +7,9 @@ Bun is a new: - Development server with 60fps Hot Module Reloading (& WIP support for React Fast Refresh) - JavaScript Runtime Environment (powered by JavaScriptCore, what WebKit/Safari uses) -All in one easy-to-use tool. +All in one fast & easy-to-use tool. Instead of 1,000 node_modules for development, you only need Bun. + +Bun is experimental software. Join [Bun's Discord](https://bun.sh/discord) for help and have a look at [things that don't work yet](#things-that-dont-work-yet). Most notably, this early version of Bun is not for building ## Install: @@ -63,11 +65,15 @@ From there, Bun relies on the filesystem for mapping dev server paths to source Here are examples of routing source code file paths: -| File Path | Dev Server URL | -| ------------------------- | -------------------------- | -| src/components/Button.tsx | /src/components/Button.tsx | -| src/index.tsx | /src/index.tsx | -| pages/index.js | /pages/index.js | +| File Path (relative to cwd) | Dev Server URL | +| --------------------------- | -------------------------- | +| src/components/Button.tsx | /src/components/Button.tsx | +| src/index.tsx | /src/index.tsx | +| pages/index.js | /pages/index.js | + +You can override the public directory by passing `--public-dir="path-to-folder"`. + +If no directory is specified and `./public/` doesn't exist, Bun will try `./static/`. If `./static/` does not exist, but won't serve from a public directory. If you pass `--public-dir=./` Bun will serve from the current directory, but it will check the current directory last instead of first. # The Bun Bundling Format |