From f3b4c478d7abc9505e58f29abaa5a49dec58df55 Mon Sep 17 00:00:00 2001
From: Mathew Biddle <8480023+MathewBiddle@users.noreply.github.com>
Date: Thu, 10 Aug 2023 10:23:50 -0400
Subject: [PATCH] adding more description to the readme

---
 README.md | 36 ++++++++++++++++++++++++------------
 1 file changed, 24 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index c763396..fc3c454 100644
--- a/README.md
+++ b/README.md
@@ -9,19 +9,31 @@ Leveraged existing resources from https://github.com/noaa-fisheries-integrated-t
 
 The webpages are built from the `website/` directory. 
 
-* `Browse_config.json` - configuration for what resources to present on the webpage.
-* `create_catalog_landing_page.py` - script to create the browse.html landing page
-* `create_tool_landing_page.py` - script to create individual tool landing pages.
-* `index.html` - html source for landing page. (links to browse.html created from `create_catalog_landing_page.py`)
-* `static/main.css` - css control for website.
-
+| File(s)                               | Description                                                   
+|---------------------------------------|---------------------------------------------------------------
+| `*_config.json`                       | configuration for what resources to present on the webpages.
+| `create_asset_inventory_page.py`      | script to create https://ioos.github.io/ioos_metrics/asset_inventory.html
+| `create_gts_atn_page.py`              | script to create https://ioos.github.io/ioos_metrics/gts_atn.html
+| `create_gts_regional_landing_page.py` | script to create https://ioos.github.io/ioos_metrics/gts_regional.html
+| `deploy/index.html`                   | html source for landing page https://ioos.github.io/ioos_metrics/index.html
+| `deploy/static/main.css`              | css control for website.
+
+## Development
+
+To create the webpages on your local system
 ```bash
->cd website
-
->python create_tool_landing_page.py
-2BOX
-AcousticThresholds
-
+>git clone https://github.com/ioos/ioos_metrics.git
+>cd ioos_metrics/website
+>python create_asset_inventory_page.py
+>python create_gts_atn_landing_page.py
 >python create_gts_regional_landing_page.py
 ```
 
+All the webpages will be saved to `website/deploy`. You can view the local html files with a web browser for testing.
+
+## Deployment
+
+The website is generated using GitHub Actions and GitHub Pages. The python scripts, referenced above, are ran and the 
+directory `website/deploy` is then uploaded as an artifact for GitHub Pages to serve as a website.
+This process is automatically ran with every push to the `main` branch. See [here](https://github.com/ioos/ioos_metrics/blob/main/.github/workflows/website_create_and_deploy.yml).
+