readme

getsentry · Nov 16, 2023 · e5511c5 · e5511c5
1 parent d71dd35
commit e5511c5
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/packages/astro/README.md b/packages/astro/README.md
@@ -0,0 +1,20 @@
+# Spotlight for Astro
+
+This is package is specifically built to add Spotlight to your Astro application with one command.
+
+## Installation
+
+```js
+npx astro add @spotlightjs/astro
+```
+
+## Usage
+
+```js
+// astro.config.mjs
+import spotlight from '@spotlightjs/astro';
+
+export default defineConfig({
+ integrations: [spotlight()],
+});
+```