From c6794904001c6974f0470cc9a66f98929ffd0551 Mon Sep 17 00:00:00 2001
From: Patrick Callahan <patricktcallahan18@gmail.com>
Date: Mon, 20 Jan 2025 10:18:12 +0100
Subject: [PATCH] Update README

---
 README.Rmd | 16 +++++++++++++---
 README.md  | 21 +++++++++++++++++----
 2 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/README.Rmd b/README.Rmd
index 6819dae..d3a5ff9 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -28,20 +28,30 @@ This package is primarily developed as a Shiny application which abstracts away
 
 ## Installation
 
-You can install the development version of ordinalsimr from [GitHub](https://github.com/) with:
+You can install the development version of ordinalsimr from GitHub with:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github(
   "NeuroShepherd/ordinalsimr",
-  force = TRUE,
   build_vignettes = TRUE
 )
 ```
 
+## Running the App
+
+The app can be started with the following code:
+
+``` r
+ordinalsimr::run_app()
+```
+
+If using the app repeatedly, it may be useful to change some of the options in the application to suit your needs. See the vignette "ordinalsimr-options" for more information, `vignette("ordinalsimr-options", package = "ordinalsimr")`.
+
+
 ## Recommendations
 
-Simulations with 1000s of iterations *will* take minutes to hours to run. This should generally be ok on the Shiny app, but if you encounter issues, consider running the simulations in a separate R session using the functions provided in this package (rather than the Shiny app).
+Simulations with 1000s of iterations *will* take minutes to hours to run. This should generally be ok on the Shiny app, but if you encounter issues, consider running the simulations in a separate R session using the functions provided in this package (rather than the Shiny app). See the vignette "coding-simulations" for more information, `vignette("coding-simulations", package = "ordinalsimr")`.
 
 
 
diff --git a/README.md b/README.md
index 8b13c6c..b32b180 100644
--- a/README.md
+++ b/README.md
@@ -33,21 +33,34 @@ up your own simulations manually.
 
 ## Installation
 
-You can install the development version of ordinalsimr from
-[GitHub](https://github.com/) with:
+You can install the development version of ordinalsimr from GitHub with:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github(
   "NeuroShepherd/ordinalsimr",
-  force = TRUE,
   build_vignettes = TRUE
 )
 ```
 
+## Running the App
+
+The app can be started with the following code:
+
+``` r
+ordinalsimr::run_app()
+```
+
+If using the app repeatedly, it may be useful to change some of the
+options in the application to suit your needs. See the vignette
+“ordinalsimr-options” for more information,
+`vignette("ordinalsimr-options", package = "ordinalsimr")`.
+
 ## Recommendations
 
 Simulations with 1000s of iterations *will* take minutes to hours to
 run. This should generally be ok on the Shiny app, but if you encounter
 issues, consider running the simulations in a separate R session using
-the functions provided in this package (rather than the Shiny app).
+the functions provided in this package (rather than the Shiny app). See
+the vignette “coding-simulations” for more information,
+`vignette("coding-simulations", package = "ordinalsimr")`.