From ea75f596e19682d9aa724592d0e32969a8df1c12 Mon Sep 17 00:00:00 2001 From: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Date: Mon, 29 Jan 2024 02:50:26 -0800 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 92bc056f..a57e5e96 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,22 @@ In this Repo you will also find the Following: - `astro-ghostcms-theme-default`: The Default theme in integration mode. - `tsconfig`: *LOCAL* Development package for `@ts-ghost/core-api`. +## Contributing + +This is a `pnpm` workspace and requires `pnpm` to function properly + +To setup this workspace clone this repo and run the following command: + +```sh +pnpm install +``` + +Then you can run the playground: + +```sh +pnpm playground:dev +``` + ### Notices *Ghost is a trademark of [The Ghost Foundation](https://ghost.org/trademark/). This project is not directly related to or provided by The Ghost Foundation and is intended to help create a easier method to utilize their provided JavaScript tools to link a Headless GhostCMS install in to your Astro project.*