Update README

The-Strategy-Unit · Mar 17, 2021 · 5f89617 · 5f89617
1 parent 8e088b0
commit 5f89617
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -19,8 +19,6 @@ knitr::opts_chunk$set(
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 <!-- badges: end -->
 
-The goal of `experiencesdashboard` is to ...
-
 ## Installation
 
 The development version is available from GitHub with:
@@ -30,6 +28,17 @@ The development version is available from GitHub with:
 # devtools::install_github("CDU-data-science-team/experiencesdashboard")
 ```
 
+## Running
+
+Run with:
+
+```{r, eval=FALSE}
+
+library(experiencesdashboard)
+run_app()
+
+```
+
 
 ## Code of Conduct
 

diff --git a/README.md b/README.md
@@ -9,8 +9,6 @@
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 <!-- badges: end -->
 
-The goal of `experiencesdashboard` is to …
-
 ## Installation
 
 The development version is available from GitHub with:
@@ -20,6 +18,15 @@ The development version is available from GitHub with:
 # devtools::install_github("CDU-data-science-team/experiencesdashboard")
 ```
 
+## Running
+
+Run with:
+
+``` r
+library(experiencesdashboard)
+run_app()
+```
+
 ## Code of Conduct
 
 Please note that the experiencesdashboard project is released with a