1 files changed, 34 insertions, 0 deletions
diff --git a/packages/astro-prism/README.md b/packages/astro-prism/README.md
new file mode 100644
index 000000000..b2dff218c
--- /dev/null
+++ b/packages/astro-prism/README.md
@@ -0,0 +1,34 @@
+# @astrojs/prism
+
+Supports Prism highlighting in Astro projects
+
+## Component
+
+This package exports a component to support highlighting inside an Astro file. Example:
+
+```astro
+---
+import { Prism } from '@astrojs/prism';
+---
+
+<Prism lang="js" code={`const foo = 'bar';`} />
+```
+
+## Internal
+
+This package exports a `runHighlighterWithAstro` function to highlight while making sure the Astro language is loaded beforehand
+
+```typescript
+import { runHighlighterWithAstro } from '@astrojs/prism';
+
+runHighlighterWithAstro(
+  `
+  ---
+    const helloAstro = 'Hello, Astro!';
+  ---
+
+  <div>{helloAstro}</div>
+`,
+  'astro',
+);
+```