Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Commit 0ca8312

Browse files
authored
Add legacy messaging (#741)
1 parent b6addc8 commit 0ca8312

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

packages/miniflare/README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# 🔥 Miniflare
1+
> [!WARNING]
2+
>
3+
> This repository is for [Miniflare 2](https://legacy.miniflare.dev/), which is
4+
> **only receiving critical security updates.** Miniflare 2 simulated the
5+
> Workers runtime and the rest of the Cloudflare developer platform using
6+
> Node.js. New versions of Miniflare can be found in the
7+
> [`workers-sdk`](https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare)
8+
> repository, and use the
9+
> [open-sourced](https://blog.cloudflare.com/workerd-open-source-workers-runtime/)
10+
> Workers runtime [`workerd`](https://github.com/cloudflare/workerd). This
11+
> practically eliminates behaviour mismatches between development and production
12+
> deployments. We recommend you
13+
> [migrate to Miniflare 3](https://miniflare.dev/get-started/migrating) now if
14+
> you can. Whilst Miniflare 3 supports most of Miniflare 2's features, one key
15+
> omission is the unit testing environment. We're actively working on adding
16+
> support for this to Miniflare 3. Once this is supported, we're planning to
17+
> deprecate Miniflare 2 and archive this repository.
18+
19+
# 🔥 Miniflare 2
220

321
**Miniflare** is a simulator for developing and testing
422
[**Cloudflare Workers**](https://workers.cloudflare.com/).
@@ -13,7 +31,7 @@
1331
It's an alternative to `wrangler dev`, written in TypeScript, that runs your
1432
workers in a sandbox implementing Workers' runtime APIs.
1533

16-
**See <https://miniflare.dev> for more detailed documentation.**
34+
**See <https://legacy.miniflare.dev> for more detailed documentation.**
1735

1836
## Features
1937

@@ -43,8 +61,8 @@ workers in a sandbox implementing Workers' runtime APIs.
4361
Miniflare is installed using npm:
4462

4563
```sh
46-
$ npm install -g miniflare # either globally..
47-
$ npm install -D miniflare # ...or as a dev dependency
64+
$ npm install -g miniflare@2 # either globally..
65+
$ npm install -D miniflare@2 # ...or as a dev dependency
4866
```
4967

5068
## Using the CLI

0 commit comments

Comments
 (0)