summaryrefslogtreecommitdiff
path: root/examples/framework-preact/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/framework-preact/README.md')
-rw-r--r--examples/framework-preact/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/examples/framework-preact/README.md b/examples/framework-preact/README.md
new file mode 100644
index 000000000..d948d9a4a
--- /dev/null
+++ b/examples/framework-preact/README.md
@@ -0,0 +1,7 @@
+# Using Preact with Astro
+
+This example showcases Astro's built-in support for [Preact](https://preactjs.com/).
+
+No configuration is needed to enable Preact support—just start writing Preact components in `src/components`.
+
+> **Note**: If used, components _must_ include the JSX factory (ex. `import { h } from "preact"`). Astro is unable to determine which framework is used without having the [JSX factory](https://mariusschulz.com/blog/per-file-jsx-factories-in-typescript#what-is-a-jsx-factory) in scope.