Clarify repository contents...

README.md

@@ -2,6 +2,13 @@
 
 # GitHub Action for an Org webR WASM R Package Repository
 
+<!-- badges: start -->
+
+[![webr-build-binary](https://github.com/coatless-tutorials/webr-org-gh-action/actions/workflows/deploy.yml/badge.svg)](https://github.com/coatless-tutorials/webr-org-gh-action/actions/workflows/deploy.yml)
+<!-- badges: end -->
+
+## Introduction
+
 This repository serves as an example of the recommended setup for
 creating a mini-CRAN repository for webR R WASM Package binaries. It
 aligns closely with the guidance provided in the webR project’s [Build R
@@ -47,6 +54,19 @@ approaches:
     the deployed content. Explore this repository to understand how this
     approach can streamline your R package deployment workflow.
 
+## Key Contents
+
+Here’s a quick summary of what you can find in the repository:
+
+- [`.github/workflows/deploy.yml`](.github/workflows/deploy.yml): A
+  replicate of the [`r-wasm/actions`’
+  deploy-cran-repo.yml](https://github.com/r-wasm/actions/blob/d21bf7da50e539df543bbee973087ec585deaba6/examples/deploy-cran-repo.yml)
+  workflow.
+- [`packages`](_pkgdown.yml): A list of R packages that adheres to
+  [package reference
+  values](https://r-lib.github.io/pkgdepends/reference/pkg_refs.html)
+  supported by `pak`.
+
 ## Setup `packages`
 
 When trying to setup an environment for your own packages, please make

README.qmd

@@ -5,6 +5,12 @@ engine: knitr
 
 # GitHub Action for an Org webR WASM R Package Repository
 
+<!-- badges: start -->
+[![webr-build-binary](https://github.com/coatless-tutorials/webr-org-gh-action/actions/workflows/deploy.yml/badge.svg)](https://github.com/coatless-tutorials/webr-org-gh-action/actions/workflows/deploy.yml)
+<!-- badges: end -->
+
+## Introduction
+
 This repository serves as an example of the recommended setup for creating a mini-CRAN repository for webR R WASM Package binaries. It aligns closely with the guidance provided in the webR project's [Build R packages using GitHub Actions](https://r-wasm.github.io/rwasm/articles/github-actions.html) documentation.
 
 This repository is part of a series exploring three different approaches:
@@ -34,6 +40,14 @@ This repository is part of a series exploring three different approaches:
     provides a transparent view of the deployed content. Explore this repository
     to understand how this approach can streamline your R package deployment workflow.
 
+## Key Contents
+
+Here's a quick summary of what you can find in the repository:
+
+- [`.github/workflows/deploy.yml`](.github/workflows/deploy.yml): A replicate of the [`r-wasm/actions`' deploy-cran-repo.yml](https://github.com/r-wasm/actions/blob/d21bf7da50e539df543bbee973087ec585deaba6/examples/deploy-cran-repo.yml) workflow.
+- [`packages`](_pkgdown.yml): A list of R packages that adheres to
+  [package reference values ](https://r-lib.github.io/pkgdepends/reference/pkg_refs.html) supported by `pak`.
+
 ## Setup `packages`
 
 When trying to setup an environment for your own packages, please make sure to modify the `packages` file to contain the appropriate [package reference value supported by `pak`](https://r-lib.github.io/pkgdepends/reference/pkg_refs.html). In the case of generating [R WASM package binaries from GitHub](https://r-lib.github.io/pkgdepends/reference/pkg_refs.html#github-packages-github-), you can achieve this with: