Fix code example in package readme (#82)

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
delucis · Jan 6, 2025 · bb13312 · bb13312
1 parent 7e22a26
commit bb13312
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.changeset/little-timers-eat.md b/.changeset/little-timers-eat.md
@@ -0,0 +1,5 @@
+---
+"astro-og-canvas": patch
+---
+
+Fixes a README code example
diff --git a/packages/astro-og-canvas/README.md b/packages/astro-og-canvas/README.md
@@ -79,6 +79,10 @@ const collectionEntries = await getCollection('my-collection');
 const pages = Object.fromEntries(collectionEntries.map(({ slug, data }) => [slug, data]));
 
 export const { getStaticPaths, GET } = OGImageRoute({
+  // Tell us the name of your dynamic route segment.
+  // In this case it’s `route`, because the file is named `[...route].ts`.
+  param: 'route',
+
   pages: pages,
 
   getImageOptions: (path, page) => ({