Add CRAN installation instructions to README (#937)

Closes #929
insightsengineering · May 25, 2023 · f5986fa · f5986fa
1 parent baf65a6
commit f5986fa
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
 # tern 0.8.2.9001
 
+### Miscellaneous
+* Updated README to include installation instructions for CRAN.
 
 # tern 0.8.2
 

diff --git a/README.md b/README.md
@@ -45,15 +45,20 @@ Many of these outputs are available to be added into [`teal`](https://insightsen
 
 ## Installation
 
-It is recommended that you [create and use a Github PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to install the latest version of this package. Once you have the PAT, run the following:
+`tern` is available on CRAN and you can install the latest released version with:
+
+```r
+install.packages("tern")
+```
+
+or you can install the latest development version directly from GitHub by running the following:
 
 ```r
-Sys.setenv(GITHUB_PAT = "your_access_token_here")
 if (!require("remotes")) install.packages("remotes")
-remotes::install_github("insightsengineering/tern@*release")
+remotes::install_github("insightsengineering/tern")
 ```
 
-A stable release of all NEST packages from October 2022 is also available [here](https://github.com/insightsengineering/depository#readme).
+Note that it is recommended you [create and use a `GITHUB_PAT`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) if installing from GitHub.
 
 See package vignettes `browseVignettes(package = "tern")` for usage of this package.
 

diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -18,7 +18,6 @@ Clopper
 Coull
 CoxPH
 Forkers
-Github
 Haenszel
 Hauck
 Hoffmann
@@ -31,6 +30,7 @@ MedDRA
 Murell
 Newcombe
 Pharmacokinetics
+README
 Repo
 Sabanés
 Satterthwaite