diff options
author | 2022-05-16 16:28:48 -0700 | |
---|---|---|
committer | 2022-05-16 16:28:48 -0700 | |
commit | dd07717b80feac5e5c8ad39fcf407a80ab5bb959 (patch) | |
tree | 78b7772a52f1ca684805666cda4b06cd2604c7c3 | |
parent | 36a82cfb93a41235e9e50abb7af9c8597f7d84bf (diff) | |
download | bun-dd07717b80feac5e5c8ad39fcf407a80ab5bb959.tar.gz bun-dd07717b80feac5e5c8ad39fcf407a80ab5bb959.tar.zst bun-dd07717b80feac5e5c8ad39fcf407a80ab5bb959.zip |
Update README.md
-rw-r--r-- | README.md | 74 |
1 files changed, 37 insertions, 37 deletions
@@ -34,7 +34,7 @@ If using Linux, kernel version 5.6 or higher is strongly recommended, but the mi - [Install](#install) - [Using bun.js - a new JavaScript runtime environment](#using-bunjs---a-new-javascript-runtime-environment) - - [Types for bun.js (editor autocomplete)](#types-for-bunjs--editor-autocomplete-) + - [Types for bun.js (editor autocomplete)](#types-for-bunjs--editor-autocomplete) - [Fast paths for Web APIs](#fast-paths-for-web-apis) - [Using bun as a package manager](#using-bun-as-a-package-manager) - [Using bun as a task runner](#using-bun-as-a-task-runner) @@ -51,30 +51,30 @@ If using Linux, kernel version 5.6 or higher is strongly recommended, but the mi - [bunfig.toml](#bunfigtoml) - [Loaders](#loaders) - [CSS in JS](#css-in-js) - - [When `platform` is `browser`](#when--platform--is--browser-) - - [When `platform` is `bun`](#when--platform--is--bun-) + - [When `platform` is `browser`](#when--platform--is--browser) + - [When `platform` is `bun`](#when--platform--is--bun) - [CSS Loader](#css-loader) - [CSS runtime](#css-runtime) - [Frameworks](#frameworks) - [Troubleshooting](#troubleshooting) - - [bun not running on an M1 (or Apple Silicon)](#bun-not-running-on-an-m1--or-apple-silicon-) + - [bun not running on an M1 (or Apple Silicon)](#bun-not-running-on-an-m1--or-apple-silicon) - [error: Unexpected](#error--unexpected) - [bun install is stuck](#bun-install-is-stuck) - [Reference](#reference) - - [`bun install`](#-bun-install-) - - [Configuring bun install with `bunfig.toml`](#configuring-bun-install-with--bunfigtoml-) + - [`bun install`](#bun-install) + - [Configuring bun install with `bunfig.toml`](#configuring-bun-install-with--bunfigtoml) - [Configuring with environment variables](#configuring-with-environment-variables) - - [Platform-specific dependencies?](#platform-specific-dependencies-) - - [Peer dependencies?](#peer-dependencies-) + - [Platform-specific dependencies?](#platform-specific-dependencies) + - [Peer dependencies?](#peer-dependencies) - [Lockfile](#lockfile) - - [Why is it binary?](#why-is-it-binary-) - - [How do I inspect it?](#how-do-i-inspect-it-) - - [What does the lockfile store?](#what-does-the-lockfile-store-) - - [Why is it fast?](#why-is-it-fast-) + - [Why is it binary?](#why-is-it-binary) + - [How do I inspect it?](#how-do-i-inspect-it) + - [What does the lockfile store?](#what-does-the-lockfile-store) + - [Why is it fast?](#why-is-it-fast) - [Cache](#cache) - [npm registry metadata](#npm-registry-metadata) - - [`bun run`](#-bun-run-) - - [`bun create`](#-bun-create-) + - [`bun run`](#bun-run) + - [`bun create`](#bun-create) - [Usage](#usage) - [Local templates](#local-templates) - [Flags](#flags) @@ -82,19 +82,19 @@ If using Linux, kernel version 5.6 or higher is strongly recommended, but the mi - [Testing your new template](#testing-your-new-template) - [Config](#config) - [How `bun create` works](#how--bun-create--works) - - [`bun bun`](#-bun-bun-) - - [Why bundle?](#why-bundle-) - - [What is `.bun`?](#what-is--bun--) + - [`bun bun`](#bun-bun) + - [Why bundle?](#why-bundle) + - [What is `.bun`?](#what-is--bun-) - [Position-independent code](#position-independent-code) - - [Where is the code?](#where-is-the-code-) + - [Where is the code?](#where-is-the-code) - [Advanced](#advanced) - - [What is the module ID hash?](#what-is-the-module-id-hash-) - - [`bun upgrade`](#-bun-upgrade-) - - [`bun completions`](#-bun-completions-) -- [`Bun.serve` - fast HTTP server](#-bunserve----fast-http-server) + - [What is the module ID hash?](#what-is-the-module-id-hash) + - [`bun upgrade`](#bun-upgrade) + - [`bun completions`](#bun-completions) +- [`Bun.serve` - fast HTTP server](#bunserve----fast-http-server) - [Usage](#usage-1) - [Error handling](#error-handling) -- [`Bun.write` – optimizing I/O](#-bunwrite----optimizing-i-o) +- [`Bun.write` – optimizing I/O](#bunwrite----optimizing-i-o) - [bun:sqlite (SQLite3 module)](#bunsqlite-sqlite3-module) - [bun:sqlite Benchmark](#bun-sqlite-benchmark) - [Getting started with bun:sqlite](#getting-started-with-bun-sqlite) @@ -110,34 +110,34 @@ If using Linux, kernel version 5.6 or higher is strongly recommended, but the mi - [Statement.get](#statementget) - [Statement.run](#statementrun) - [Statement.finalize](#statementfinalize) - - [Statement.toString()](#statementtostring--) + - [Statement.toString()](#statementtostring-) - [Datatypes](#datatypes) -- [`bun:ffi` (Foreign Functions Interface)](#-bun-ffi---foreign-functions-interface-) +- [`bun:ffi` (Foreign Functions Interface)](#bun-ffi---foreign-functions-interface) - [Low-overhead FFI](#low-overhead-ffi) - [Usage](#usage-2) - - [Supported FFI types (`FFIType`)](#supported-ffi-types---ffitype--) - - [Strings (`CString`)](#strings---cstring--) + - [Supported FFI types (`FFIType`)](#supported-ffi-types---ffitype-) + - [Strings (`CString`)](#strings---cstring-) - [Returning a string](#returning-a-string) - [Function pointers](#function-pointers) - [Pointers](#pointers) - [Passing a pointer](#passing-a-pointer) - [Reading pointers](#reading-pointers) - [Not implemented yet](#not-implemented-yet-1) -- [Node-API (napi)](#node-api--napi-) -- [`Bun.Transpiler`](#-buntranspiler-) - - [`Bun.Transpiler.transformSync`](#-buntranspilertransformsync-) - - [`Bun.Transpiler.transform`](#-buntranspilertransform-) - - [`Bun.Transpiler.scan`](#-buntranspilerscan-) - - [`Bun.Transpiler.scanImports`](#-buntranspilerscanimports-) +- [Node-API (napi)](#node-api--napi) +- [`Bun.Transpiler`](#buntranspiler) + - [`Bun.Transpiler.transformSync`](#buntranspilertransformsync) + - [`Bun.Transpiler.transform`](#buntranspilertransform) + - [`Bun.Transpiler.scan`](#buntranspilerscan) + - [`Bun.Transpiler.scanImports`](#buntranspilerscanimports) - [Environment variables](#environment-variables) - [Credits](#credits) - [License](#license) - [Developing bun](#developing-bun) - - [VSCode Dev Container (Linux)](#vscode-dev-container--linux-) + - [VSCode Dev Container (Linux)](#vscode-dev-container--linux) - [MacOS](#macos) - - [Build bun (macOS)](#build-bun--macos-) - - [Verify it worked (macOS)](#verify-it-worked--macos-) - - [Troubleshooting (macOS)](#troubleshooting--macos-) + - [Build bun (macOS)](#build-bun--macos) + - [Verify it worked (macOS)](#verify-it-worked--macos) + - [Troubleshooting (macOS)](#troubleshooting--macos) - [vscode-zig](#vscode-zig) ## Using bun.js - a new JavaScript runtime environment |