From 435673ed45cd9feb34dc5a16f5a9fe7178b98e29 Mon Sep 17 00:00:00 2001
From: Josh <joshua_lu1@brown.edu>
Date: Fri, 8 Dec 2023 11:20:27 -0500
Subject: [PATCH] Updates to README

---
 README.md | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 84a3433..a337c91 100644
--- a/README.md
+++ b/README.md
@@ -7,36 +7,45 @@ A usage of
 [gatsby-theme-project-portal](https://github.com/thepolicylab-projectportals/project-portal-theme)
 for the (fictional) State of Quinetucket. 
 
+The set of instructions below can be applied to any respective partner's Project Portal repository to spin up a local version of the respective Project Portal site.
+
 ## Quick Start Guide
 
 Clone the repo
+```shell
+git clone https://github.com/thepolicylab-projectportals/example-content.git
+```
+Run the following command to install the required dependencies.
 
-Run
+```shell
+yarn install
+```
 
+Afterwards, run the following command to generate a production-ready version of your website. Currently, the production-ready version is required to enable the site-wide `Search` feature.
 ```shell
-yarn
+yarn build
 ```
 
-then
+Once the build process is completed, run the following command to preview the production build locally. 
 ```shell
-yarn develop
+yarn serve
 ```
 
-## Accessing the Developer CMS
+## Accessing Decap CMS
 
-Change static/admin/config.yml
+Navigate to [static/admin/config.yml](./static/admin/config.yml) and make the following change locally:
 
 ```yaml
 local_backend: true
 ```
 
-Run in a second terminal
+Spin up the `decap-server` in a separate terminal by running the following command.
 
 ```shell
 npx decap-server
 ```
 
-### Enabling users to access Netlify CMS
+### Enabling users to access Decap CMS
 Add the users to the "Identity" tab in the Netlify CMS UI.
 You also need to activate:
 - Any external providers which are wanted: GitHub or Google are commonly used at CCV.