From c50f8d82d5069af4067627b88499494d8e28fbb1 Mon Sep 17 00:00:00 2001 From: Jarred Sumner Date: Mon, 2 Sep 2024 05:06:45 -0700 Subject: [PATCH] Remove outdated callout Still very active! More stable though. --- README.md | 47 ++++++++++++++++++++++++++++++++--------------- docs/index.md | 4 ---- 2 files changed, 32 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 63c6d5e0b7..cf407d1a25 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,6 @@ ## What is Bun? -> **Bun is under active development.** Use it to speed up your development workflows or run simpler production code in resource-constrained environments like serverless functions. We're working on more complete Node.js compatibility and integration with existing frameworks. Join the [Discord](https://bun.sh/discord) and watch the [GitHub repository](https://github.com/oven-sh/bun) to keep tabs on future releases. - Bun is an all-in-one toolkit for JavaScript and TypeScript apps. It ships as a single executable called `bun`. At its core is the _Bun runtime_, a fast JavaScript runtime designed as a drop-in replacement for Node.js. It's written in Zig and powered by JavaScriptCore under the hood, dramatically reducing startup times and memory usage. @@ -87,16 +85,19 @@ bun upgrade --canary ## Quick links - Intro + - [What is Bun?](https://bun.sh/docs/index) - [Installation](https://bun.sh/docs/installation) - [Quickstart](https://bun.sh/docs/quickstart) - [TypeScript](https://bun.sh/docs/typescript) - Templating + - [`bun init`](https://bun.sh/docs/cli/init) - [`bun create`](https://bun.sh/docs/cli/bun-create) - Runtime + - [`bun run`](https://bun.sh/docs/cli/run) - [File types](https://bun.sh/docs/runtime/loaders) - [TypeScript](https://bun.sh/docs/runtime/typescript) @@ -115,6 +116,7 @@ bun upgrade --canary - [Framework API](https://bun.sh/docs/runtime/framework) - Package manager + - [`bun install`](https://bun.sh/docs/cli/install) - [`bun add`](https://bun.sh/docs/cli/add) - [`bun remove`](https://bun.sh/docs/cli/remove) @@ -130,6 +132,7 @@ bun upgrade --canary - [Overrides and resolutions](https://bun.sh/docs/install/overrides) - Bundler + - [`Bun.build`](https://bun.sh/docs/bundler) - [Loaders](https://bun.sh/docs/bundler/loaders) - [Plugins](https://bun.sh/docs/bundler/plugins) @@ -137,6 +140,7 @@ bun upgrade --canary - [vs esbuild](https://bun.sh/docs/bundler/vs-esbuild) - Test runner + - [`bun test`](https://bun.sh/docs/cli/test) - [Writing tests](https://bun.sh/docs/test/writing) - [Watch mode](https://bun.sh/docs/test/hot) @@ -148,9 +152,11 @@ bun upgrade --canary - [Code coverage](https://bun.sh/docs/test/coverage) - Package runner + - [`bunx`](https://bun.sh/docs/cli/bunx) - API + - [HTTP server](https://bun.sh/docs/api/http) - [WebSockets](https://bun.sh/docs/api/websockets) - [Workers](https://bun.sh/docs/api/workers) @@ -183,9 +189,10 @@ bun upgrade --canary - [Building Windows](https://bun.sh/docs/project/building-windows) - [License](https://bun.sh/docs/project/licensing) -## Guides +## Guides + +- Binary -- Binary - [Convert a Blob to a DataView](https://bun.sh/guides/binary/blob-to-dataview) - [Convert a Blob to a ReadableStream](https://bun.sh/guides/binary/blob-to-stream) - [Convert a Blob to a string](https://bun.sh/guides/binary/blob-to-string) @@ -209,7 +216,8 @@ bun upgrade --canary - [Convert an ArrayBuffer to a Uint8Array](https://bun.sh/guides/binary/arraybuffer-to-typedarray) - [Convert an ArrayBuffer to an array of numbers](https://bun.sh/guides/binary/arraybuffer-to-array) -- Ecosystem +- Ecosystem + - [Build a frontend using Vite and Bun](https://bun.sh/guides/ecosystem/vite) - [Build an app with Astro and Bun](https://bun.sh/guides/ecosystem/astro) - [Build an app with Next.js and Bun](https://bun.sh/guides/ecosystem/nextjs) @@ -236,7 +244,8 @@ bun upgrade --canary - [Use React and JSX](https://bun.sh/guides/ecosystem/react) - [Add Sentry to a Bun app](https://bun.sh/guides/ecosystem/sentry) -- HTTP +- HTTP + - [Common HTTP server usage](https://bun.sh/guides/http/server) - [Configure TLS on an HTTP server](https://bun.sh/guides/http/tls) - [fetch with unix domain sockets in Bun](https://bun.sh/guides/http/fetch-unix) @@ -250,7 +259,8 @@ bun upgrade --canary - [Upload files via HTTP using FormData](https://bun.sh/guides/http/file-uploads) - [Write a simple HTTP server](https://bun.sh/guides/http/simple) -- Install +- Install + - [Add a dependency](https://bun.sh/guides/install/add) - [Add a development dependency](https://bun.sh/guides/install/add-dev) - [Add a Git dependency](https://bun.sh/guides/install/add-git) @@ -268,7 +278,8 @@ bun upgrade --canary - [Using bun install with an Azure Artifacts npm registry](https://bun.sh/guides/install/azure-artifacts) - [Using bun install with Artifactory](https://bun.sh/guides/install/jfrog-artifactory) -- Process +- Process + - [Get the process uptime in nanoseconds](https://bun.sh/guides/process/nanoseconds) - [Listen for CTRL+C](https://bun.sh/guides/process/ctrl-c) - [Listen to OS signals](https://bun.sh/guides/process/os-signals) @@ -279,7 +290,8 @@ bun upgrade --canary - [Spawn a child process](https://bun.sh/guides/process/spawn) - [Spawn a child process and communicate using IPC](https://bun.sh/guides/process/ipc) -- Read file +- Read file + - [Check if a file exists](https://bun.sh/guides/read-file/exists) - [Get the MIME type of a file](https://bun.sh/guides/read-file/mime) - [Read a file as a ReadableStream](https://bun.sh/guides/read-file/stream) @@ -290,7 +302,8 @@ bun upgrade --canary - [Read a JSON file](https://bun.sh/guides/read-file/json) - [Watch a directory for changes](https://bun.sh/guides/read-file/watch) -- Runtime +- Runtime + - [Debugging Bun with the VS Code extension](https://bun.sh/guides/runtime/vscode-debugger) - [Debugging Bun with the web debugger](https://bun.sh/guides/runtime/web-debugger) - [Define and replace static globals & constants](https://bun.sh/guides/runtime/define-constant) @@ -305,7 +318,8 @@ bun upgrade --canary - [Set a time zone in Bun](https://bun.sh/guides/runtime/timezone) - [Set environment variables](https://bun.sh/guides/runtime/set-env) -- Streams +- Streams + - [Convert a Node.js Readable to a Blob](https://bun.sh/guides/streams/node-readable-to-blob) - [Convert a Node.js Readable to a string](https://bun.sh/guides/streams/node-readable-to-string) - [Convert a Node.js Readable to an ArrayBuffer](https://bun.sh/guides/streams/node-readable-to-arraybuffer) @@ -318,7 +332,8 @@ bun upgrade --canary - [Convert a ReadableStream to an ArrayBuffer](https://bun.sh/guides/streams/to-arraybuffer) - [Convert a ReadableStream to JSON](https://bun.sh/guides/streams/to-json) -- Test +- Test + - [Bail early with the Bun test runner](https://bun.sh/guides/test/bail) - [Generate code coverage reports with the Bun test runner](https://bun.sh/guides/test/coverage) - [Mark a test as a "todo" with the Bun test runner](https://bun.sh/guides/test/todo-tests) @@ -336,7 +351,8 @@ bun upgrade --canary - [Use snapshot testing in `bun test`](https://bun.sh/guides/test/snapshot) - [Write browser DOM tests with Bun and happy-dom](https://bun.sh/guides/test/happy-dom) -- Util +- Util + - [Check if the current file is the entrypoint](https://bun.sh/guides/util/entrypoint) - [Check if two objects are deeply equal](https://bun.sh/guides/util/deep-equals) - [Compress and decompress data with DEFLATE](https://bun.sh/guides/util/deflate) @@ -355,13 +371,14 @@ bun upgrade --canary - [Hash a password](https://bun.sh/guides/util/hash-a-password) - [Sleep for a fixed number of milliseconds](https://bun.sh/guides/util/sleep) -- WebSocket +- WebSocket + - [Build a publish-subscribe WebSocket server](https://bun.sh/guides/websocket/pubsub) - [Build a simple WebSocket server](https://bun.sh/guides/websocket/simple) - [Enable compression for WebSocket messages](https://bun.sh/guides/websocket/compression) - [Set per-socket contextual data on a WebSocket](https://bun.sh/guides/websocket/context) -- Write file +- Write file - [Append content to a file](https://bun.sh/guides/write-file/append) - [Copy a file to another location](https://bun.sh/guides/write-file/file-cp) - [Delete a file](https://bun.sh/guides/write-file/unlink) diff --git a/docs/index.md b/docs/index.md index 05f8182501..8a994cbcff 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,10 +16,6 @@ $ bun test # run tests $ bunx cowsay 'Hello, world!' # execute a package ``` -{% callout type="note" %} -**Bun is still under development.** Use it to speed up your development workflows or run simpler production code in resource-constrained environments like serverless functions. We're working on more complete Node.js compatibility and integration with existing frameworks. Join the [Discord](https://bun.sh/discord) and watch the [GitHub repository](https://github.com/oven-sh/bun) to keep tabs on future releases. -{% /callout %} - Get started with one of the quick links below, or read on to learn more about Bun. {% block className="gap-2 grid grid-flow-row grid-cols-1 md:grid-cols-2" %}