From 9b9fbd3a19b23c1af4a060f50b44a329e0fc359d Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:19:07 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 160 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..051476e --- /dev/null +++ b/README.en.md @@ -0,0 +1,160 @@ +

Cloudflare Workers SDK

+ +

+workers-logo +
+ Cloudflare Workers let you deploy serverless code instantly across the globe for exceptional performance, reliability, and scale. +
+

+ +

+ Contribute + · + Submit an Issue + · + Join Discord +
+
+

+ +

+ + Wrangler on npm +   + + Discord conversation +   + + X conversation + +

+ +
+ +## Quick Start + +To get started quickly with a new project, run the command below: + +```bash +npm create cloudflare@latest +# or +pnpm create cloudflare@latest +# or +yarn create cloudflare@latest +``` + +For more info, visit our [Getting Started](https://developers.cloudflare.com/workers/get-started/guide/) guide. + +## Documentation + +Visit the official Workers documentation [here](https://developers.cloudflare.com/workers/). + +- [Getting Started](https://developers.cloudflare.com/workers/get-started/guide/) +- [How Workers works](https://developers.cloudflare.com/workers/reference/how-workers-works/) +- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/) +- [Observability](https://developers.cloudflare.com/workers/observability/) +- [Platform](https://developers.cloudflare.com/workers/platform/) + +## Directory + +| Package | Description | Links | +| ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| [`wrangler`](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler) | A command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/). | [Docs](https://developers.cloudflare.com/workers/wrangler/) | +| [`create-cloudflare` (C3)](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare) | A CLI for creating and deploying new applications to Cloudflare. | [Docs](https://developers.cloudflare.com/pages/get-started/c3/) | +| [`miniflare`](https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare) | A simulator for developing and testing Cloudflare Workers, powered by [workerd](https://github.com/cloudflare/workerd) | [Docs](https://miniflare.dev) | +| [`chrome-devtools-patches`](https://github.com/cloudflare/workers-sdk/tree/main/packages/chrome-devtools-patches) | Cloudflare's fork of Chrome DevTools for inspecting your local or remote Workers | | +| [`pages-shared`](https://github.com/cloudflare/workers-sdk/tree/main/packages/pages-shared) | Used internally to power Wrangler and Cloudflare Pages. It contains all the code that is shared between these clients. | | + +## Beta releases + +Beta releases are generated by the [pkg.pr.new](https://github.com/stackblitz-labs/pkg.pr.new) tool and are updated on every commit pushed to the `main` branch. + +> [!Warning] +> These beta releases get updated over time, so they are ill suited to be used as stable versions for a project (and the proper npm released should be used instead). These should be used only for quick testing of not yet released features/fixes. + +Available beta releases are listed below. + +
create-cloudflare

+ +``` +npm i https://pkg.pr.new/create-cloudflare@main +``` + +

+ +
@cloudflare/kv-asset-handler

+ +``` +npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@main +``` + +

+ +
miniflare

+ +``` +npm i https://pkg.pr.new/miniflare@main +``` + +

+ +
@cloudflare/pages-shared

+ +``` +npm i https://pkg.pr.new/@cloudflare/pages-shared@main +``` + +

+ +
@cloudflare/unenv-preset

+ +``` +npm i https://pkg.pr.new/@cloudflare/unenv-preset@main +``` + +

+ +
@cloudflare/vite-plugin

+ +``` +npm i https://pkg.pr.new/@cloudflare/vite-plugin@main +``` + +

+ +
@cloudflare/vitest-pool-workers

+ +``` +npm i https://pkg.pr.new/@cloudflare/vitest-pool-workers@main +``` + +

+ +
@cloudflare/workers-editor-shared

+ +``` +npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@main +``` + +

+ +
wrangler

+ +``` +npm i https://pkg.pr.new/wrangler@main +``` + +

+ +## Contributing + +We welcome new contributors! Refer to the [`CONTRIBUTING.md`](/CONTRIBUTING.md) guide for details. + +## Community + +Join us in the official [Cloudflare Discord](https://discord.cloudflare.com/) to meet other developers, ask questions, or learn more in general. + +## Links + +- [Project Board](https://github.com/orgs/cloudflare/projects/1) +- [Discussions](https://github.com/cloudflare/workers-sdk/discussions)