|
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 |
2 | 20 |
|
3 | 21 | **Miniflare** is a simulator for developing and testing |
4 | 22 | [**Cloudflare Workers**](https://workers.cloudflare.com/). |
|
13 | 31 | It's an alternative to `wrangler dev`, written in TypeScript, that runs your |
14 | 32 | workers in a sandbox implementing Workers' runtime APIs. |
15 | 33 |
|
16 | | -**See <https://miniflare.dev> for more detailed documentation.** |
| 34 | +**See <https://legacy.miniflare.dev> for more detailed documentation.** |
17 | 35 |
|
18 | 36 | ## Features |
19 | 37 |
|
@@ -43,8 +61,8 @@ workers in a sandbox implementing Workers' runtime APIs. |
43 | 61 | Miniflare is installed using npm: |
44 | 62 |
|
45 | 63 | ```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 |
48 | 66 | ``` |
49 | 67 |
|
50 | 68 | ## Using the CLI |
|
0 commit comments