add a bonus section, a badge, and remove redundant image

README.Rmd

@@ -4,18 +4,10 @@ output: github_document
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-```{r, include = FALSE}
-knitr::opts_chunk$set(
-  collapse = TRUE,
-  comment = "#>",
-  fig.path = "man/figures/README-",
-  out.width = "100%"
-)
-```
-
 # repositoryr
 
 <!-- badges: start -->
+[![R-CMD-check](https://github.com/ImperialCollegeLondon/repositoryr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ImperialCollegeLondon/repositoryr/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
 The goal of repositoryr is to provide a step by step guide to creating a R package repository.
@@ -124,6 +116,27 @@ git push --set-upstream origin main
 - This will add the necessary components and sets up GitHub Actions for automatic site building when deploying. 
 - Your `README.md` becomes the homepage, documentation in `man/` generates a function reference, and vignettes will be rendered into `articles/`.
 
+## Bonus!
+
+- Add a GitHub action workflow to render Rmarkdown using `usethis::use_github_action("render-rmarkdown")`.
+- Add another action to lint your package using `usethis::use_github_action("lint")`.
+- Add a `R CMD-check` badge using `usethis::use_github_actions_badge()`.
+- Customise the package website by editing the `_pkgdown.yml` file. For example, you can add a lightswitch and GitHub repository button to the navbar:
+
+```yaml
+template:
+  bootstrap: 5
+  light-switch: true
+navbar:
+  structure:
+    right: [search, github, lightswitch]
+  components:
+    github:
+      icon: fa-github
+      href: https://github.com/<owner-name>/<repo-name>
+      aria-label: GitHub
+```
+
 ## Installation
 
 You can install the development version of repositoryr from [GitHub](https://github.com/) with:

README.md

@@ -4,6 +4,8 @@
 # repositoryr
 
 <!-- badges: start -->
+
+[![R-CMD-check](https://github.com/ImperialCollegeLondon/repositoryr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ImperialCollegeLondon/repositoryr/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
 The goal of repositoryr is to provide a step by step guide to creating a
@@ -173,6 +175,31 @@ repo](https://happygitwithr.com/existing-github-last.html#create-and-connect-a-g
   generates a function reference, and vignettes will be rendered into
   `articles/`.
 
+## Bonus!
+
+- Add a GitHub action workflow to render Rmarkdown using
+  `usethis::use_github_action("render-rmarkdown")`.
+- Add another action to lint your package using
+  `usethis::use_github_action("lint")`.
+- Add a `R CMD-check` badge using `usethis::use_github_actions_badge()`.
+- Customise the package website by editing the `_pkgdown.yml` file. For
+  example, you can add a lightswitch and GitHub repository button to the
+  navbar:
+
+``` yaml
+template:
+  bootstrap: 5
+  light-switch: true
+navbar:
+  structure:
+    right: [search, github, lightswitch]
+  components:
+    github:
+      icon: fa-github
+      href: https://github.com/<owner-name>/<repo-name>
+      aria-label: GitHub
+```
+
 ## Installation
 
 You can install the development version of repositoryr from