diff --git a/README.md b/README.md
index e9695b5..cca0b74 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
# BCDC - SMK
+
+
-This repository contains the code that run's the base SMK site that the
+This repository contains the code that run's the base SMK site that the
BC Data Catalog will use for map previews.
# How to update to a new SMK version
@@ -12,6 +14,7 @@ BC Data Catalog will use for map previews.
As the header suggests start by cloneing this repo, then go into the repo
directory, and make sure you are on the dev branch. (The default repo
is configured to be dev so you should already be on it)
+
```
git clone https://github.com/bcgov/bcdc-smk
cd bcdc-smk
@@ -32,26 +35,27 @@ Update the text `1.0.0-beta.2` to whatever the latest version is
## Test the change
-Delete the following files / directories if they exist in your repo directory, if you
+Delete the following files / directories if they exist in your repo directory, if you
haven't already built then they won't exist.
* package-lock.json
* node_modules
Install dependencies:
+
```
npm install
```
Start the web server:
+
```
node node_modules/http-server/bin/http-server
```
-Navigate the url that the previous command generates and verify that the
+Navigate the url that the previous command generates and verify that the
map at that url displays.
-
## Build - Test - Deploy (CD/CI)
This is automated through github actions. The image stream for bcdc-smk
@@ -61,7 +65,7 @@ To trigger a build / dev deploy commit changes, push to github and create a pull
#### Commit / push changes
-To deploy stage and commit the changes you have made and push them up
+To deploy stage and commit the changes you have made and push them up
to `origin`.
```
@@ -72,21 +76,23 @@ git push origin dev
#### Trigger CD/CI pipeline
-The pipeline is configured to be triggered by a pull request. Create a new
+The pipeline is configured to be triggered by a pull request. Create a new
pull request **from:** *dev* **to:** *master*
Pipeline will:
+
1. create an image tag
-1. create a new docker image
-1. tags the docker image
-1. deploys the image to a dev oc namespace
-1. updates the pr request with the url to the newly deployed version of the app
-1. sends reviewers a notification letting them know we are awaiting a review
+2. create a new docker image
+3. tags the docker image
+4. deploys the image to a dev oc namespace
+5. updates the pr request with the url to the newly deployed version of the app
+6. sends reviewers a notification letting them know we are awaiting a review
pr. closed and merged to master
+
1. deploys the image to prod
-1. tags the merged commit with the image tag
-1. deploys to prod
-1. deletes the dev env.
+2. tags the merged commit with the image tag
+3. deploys to prod
+4. deletes the dev env.
-
\ No newline at end of file
+