summaryrefslogtreecommitdiff
path: root/examples/cms-prismic/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cms-prismic/README.md')
-rw-r--r--examples/cms-prismic/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/examples/cms-prismic/README.md b/examples/cms-prismic/README.md
new file mode 100644
index 000000000..c03000d46
--- /dev/null
+++ b/examples/cms-prismic/README.md
@@ -0,0 +1,16 @@
+# Astro With Prismic CMS
+
+```
+npm init astro -- --template cms-prismic
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/snowpackjs/astro/tree/latest/examples/cms-prismic)
+
+This example showcases Astro working with Prismic.
+
+This example is depending on the [Prismic custom type](https://prismic.io/docs/core-concepts/custom-types) setup.
+Before running the dev server (`npm start`/`npm run dev`) follow the setup steps below.
+### Setup Steps:
+- Set up prismic custom types and pages.
+Please refer to the custom type example in the `Prismic Template` folder.
+- Create a `.env` file following the `.env.example` file. \ No newline at end of file