aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-09-23 23:22:41 -0700
committerGravatar Jarred Sumner <jarred@jarredsumner.com> 2021-09-23 23:22:41 -0700
commit90a647fb72595d64013f9595c36ed7e557d669da (patch)
treeec42d81e061eb3d6591a467373e1df0fbffade9d
parent3cbf209d5b43c6ece8b914a3aadd7d19b636cd34 (diff)
downloadbun-90a647fb72595d64013f9595c36ed7e557d669da.tar.gz
bun-90a647fb72595d64013f9595c36ed7e557d669da.tar.zst
bun-90a647fb72595d64013f9595c36ed7e557d669da.zip
Update README.md
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index c5421f83a..c30474ae5 100644
--- a/README.md
+++ b/README.md
@@ -427,8 +427,19 @@ Run `bun bun ./path-to.js` to generate a `node_modules.bun` file containing all
The `.bun` file contains:
- all the bundled source code
-- all the bundled source code metadata (what byte ranges of the `.bun` correspond to which module's source code? what modules were used in a package?)
-- project metadata & configuration (what framework? where is the routes folder?)
+- all the bundled source code metadata
+- project metadata & configuration
+
+Here are some of the questions `.bun` files answer:
+
+- what byte ranges of the `.bun` correspond to which module's source code?
+- what modules of a package are used?
+- what framework is used? (e.g. Next.js)
+- where is the routes directory?
+- how big is each imported dependency?
+- what is the hash of the bundle's contents? (for etags)
+- what is the name & version of every npm package exported in this bundle?
+- what modules from which packages are used in this project? ("project" defined as all the entry points used to generate the .bun)
All in one file.