Update README.md

This commit is contained in:
Jarred Sumner
2021-10-16 23:52:57 -07:00
parent e63fbcefe9
commit 797c94b0e9

View File

@@ -570,6 +570,13 @@ IF remote template
- If there are files that would overwrite, warn and exit unless `--force` is passed
IF github repo
1. Download the tarball from GitHub's API
2. Decompress & extract into `${destination}`
- If there are files that would overwrite, warn and exit unless `--force` is passed
ELSE IF local template
1. Open local template folder
@@ -577,7 +584,7 @@ ELSE IF local template
3. Copy files recursively using the fastest system calls available (on macOS `fcopyfile` and Linux, `copy_file_range`). Do not copy or traverse into `node_modules` folder if exists (this alone makes it faster than `cp`)
4. Parse the `package.json` (again!), update `name` to be `${basename(destination)}`, remove the `bun-create` section from the `package.json` and save the updated `package.json` to disk.
- IF Next.js is detected, add `bun-framework-next` to the list of imports
- IF Next.js is detected, add `bun-framework-next` to the list of dependencies
- IF Create React App is detected, add the entry point in /src/index.{js,jsx,ts,tsx} to `public/index.html`
- IF Relay is detected, add `bun-macro-relay` so that Relay works
5. Auto-detect the npm client, preferring `pnpm`, `yarn` (v1), and lastly `npm`
@@ -588,7 +595,7 @@ ELSE IF local template
- Rename `gitignore` to `.gitignore`. NPM automatically removes `.gitignore` files from appearing in packages.
- If there are dependencies, this runs in a separate thread concurrently while node_modules are being installed
- Using libgit2 if available was tested and performed roughly 3x slower in microbenchmarks
- Using libgit2 if available was tested and performed 3x slower in microbenchmarks
10. Done