docs: updates README to include more informatoin and static.json type…

… definitions

README.md

@@ -13,6 +13,10 @@
 
 This is a static research data portal powered by Globus.
 
+View the result at: [globus.github.io/example-data-portal](https://globus.github.io/example-data-portal).
+
+While this repository is a working example of a data portal, it is also a template for [creating your own static research data portal](#creating-your-own-static-research-data-portal).
+
 ----
 
 ### Creating Your Own Static Research Data Portal
@@ -26,26 +30,60 @@ This is a static research data portal powered by Globus.
    * Update the **Redirects** to include your GitHub Pages URL + `/authenticate`, i.e., `https://globus.github.io/example-data-portal/authenticate`.
    * Optional: Specify the **Privacy Policy URL** and **Terms & Conditions URL** to the portal-provided routes, i.e. `https://globus.github.io/example-data-portal/privacy-policy`
 1. Update the `static.json` to include:
-   * `globus.application.client_id` – The UUID of the client created in **the previous step**.
-   * `globus.transfer.collection_id` – The Collection UUID that will be the "source" of your data portal.
+   * `data.attributes.globus.application.client_id` – The UUID of the client created in **the previous step**.
+   * `data.attributes.globus.transfer.collection_id` – The Collection UUID that will be the "source" of your data portal.
+   * See the [static.json](#staticjson) type definitions for more configuration options.
 1. **That's it!** The changes made (and any future changes) to the `static.json` will trigger a GitHub Action that will automatically build and deploy your research data portal to your GitHub Pages URL.
 
+
+#### Common Changes after Creating Your Portal
+
+- **Updating the Title and Tagline** – Update the `data.attributes.content.title` and `data.attributes.content.tagline` in the `static.json`.
+- **Updating the Privacy Policy and Terms of Service** – Update the `data.attributes.content.privacy_policy` and `data.attributes.content.terms_of_service` in the `static.json`.
+- **Changing the Collection Path** – Update the `data.attributes.globus.transfer.path` in the `static.json`.
+- **Removing this section of the README** – Remove this section from the `README.md` file.
+- **Edit/Remove the `CITATION` file** – Update the `CITATION` file to reflect the appropriate citation information for your research data portal – [learn more about `CITATION` files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files).
+
+
 ----
 
 # Features + Functionality
 
 ## Data Portal
 
+- **Powered by [Globus](https://www.globus.org/)**
 - List the directory contents of a configured Globus collection at a specific path.
   - Support for [HTTPS Access](https://docs.globus.org/globus-connect-server/v5.4/https-access-collections/) download of files where available.
 - Transfer data from the configured collection to another Globus collection.
 
-### `static.json`
-
-
 ## GitHub Repository
 
-- 🚀 **Automated Deployments to GitHub Pages** – Any file changes will result in your data portal's deployment (and rebuild).
+- 📄 **Hosted via GitHub Pages** – Users can access your data portal at this repository's GitHub Pages URL. Use all the functionality built-in to GitHub pages to suit your needs, including [configuring a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages).
+
+- 🚀 **Automated Deployments via GitHub Actions** – Any file changes will result in the deployment (and rebuild) of your data portal.
    - You can manually trigger a deployment by navigating to the **Actions** tab and selecting the **static** workflow.
 
 - 🤖 **Dependabot** – A default [Dependabot](https://docs.github.com/en/code-security/dependabot) configuration ([`.github/dependabot.yml`](.github/dependabot.yml)) to keep your repository up-to-date with latest changes to [globus/static-data-portal](https://github.com/globus/static-data-portal).
+
+### `static.json`
+
+The type used for `data` by the [@globus/static-data-portal generator](https://github.com/globus/static-data-portal).
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `attributes` | \{ `content`: \{ `privacy_policy?`: `string` ; `tagline?`: `string` ; `terms_of_service?`: `string` ; `title`: `string`  } ; `globus`: \{ `application`: \{ `client_id`: `string` ; `redirect_uri?`: `string`  } ; `transfer`: \{ `collection_id`: `string` ; `path?`: `string`  }  }  } | - |
+| `attributes.content` | \{ `privacy_policy?`: `string` ; `tagline?`: `string` ; `terms_of_service?`: `string` ; `title`: `string`  } | - |
+| `attributes.content.privacy_policy?` | `string` | A privacy policy to be rendered at `/privacy-policy`. This is especially useful for associating the published URL with your registered Globus Auth application. |
+| `attributes.content.tagline?` | `string` | - |
+| `attributes.content.terms_of_service?` | `string` | Terms and conditions to be rendered at `/terms-and-conditions`. This is especially useful for associating the published URL with your registered Globus Auth application. |
+| `attributes.content.title` | `string` | The title of the research data portal. |
+| `attributes.globus` | \{ `application`: \{ `client_id`: `string` ; `redirect_uri?`: `string`  } ; `transfer`: \{ `collection_id`: `string` ; `path?`: `string`  }  } | - |
+| `attributes.globus.application` | \{ `client_id`: `string` ; `redirect_uri?`: `string`  } | Information about your registered Globus Auth Application (Client) **`See`** https://docs.globus.org/api/auth/developer-guide/#developing-apps |
+| `attributes.globus.application.client_id` | `string` | The UUID of the client application. |
+| `attributes.globus.application.redirect_uri?` | `string` | The redirect URI for the Globus Auth login page to complete the OAuth2 flow. The portal will make a reasonable effort to determine this URI, but this field is provided as a fallback. To use the portal's built-in authorization handling, redirects should be sent to `/authenticate` on the host. **`Example`** ```ts "https://example.com/data-portal/authenticate" ``` |
+| `attributes.globus.transfer` | \{ `collection_id`: `string` ; `path?`: `string`  } | Configuration for Transfer-related functionality in the portal. |
+| `attributes.globus.transfer.collection_id` | `string` | The UUID of the Globus collection to list and transfer files from. |
+| `attributes.globus.transfer.path?` | `string` | The path on the collection to list and transfer files from. |
+| `version` | `string` | The version of the `data` object, which is used to determine how the generator will render its `attributes`. **`Example`** ```ts "1.0.0" ``` |