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

Commit 00b7beb

Browse files
authored
Revise README to reflect project status
Updated README to indicate that Microsite is no longer maintained and serves as a reference for islands architecture.
1 parent 533752e commit 00b7beb

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

packages/microsite/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
> [!CAUTION]
2+
> Microsite is no longer maintained. The partial hydration techniques pioneered in this project served as a precursor to [Astro](https://astro.build/), which [@natemoo-re](https://github.com/natemoo-re) co-created, and a number of other islands architecture-based frameworks like [Fresh](https://fresh.deno.dev/).
3+
>
4+
> Consider this archive a reference implementation for islands architecture—may it inspire you to _do more with less JavaScript_.
5+
6+
</div>
7+
18
<br />
29
<br />
310

@@ -24,10 +31,6 @@ npm init microsite
2431

2532
---
2633

27-
Microsite's public API is quite stable, but I caution **professional users** to consider this a WIP! There are plenty of quirks and bugs (especially with `dev` mode) that are being ironed out until Microsite reaches a more stable v2.0.0!
28-
29-
---
30-
3134
Microsite is an **ESM node package**, so it needs to run in a Node environment which supports ESM. We support the latest version of [`node` v12.x LTS (Erbium)](https://nodejs.org/download/release/latest-v12.x/) — see [Engines](https://github.com/natemoo-re/microsite/blob/main/docs/engines.md) for more details.
3235

3336
Ensure that your project includes `"type": "module"` in `package.json`, which will allow you to use ESM in your project's `node` scripts.

0 commit comments

Comments
 (0)