From 307bf7a52138683f9903241b9f16491bff8c8789 Mon Sep 17 00:00:00 2001 From: Dave Slager Date: Sun, 11 Feb 2024 16:24:34 -0800 Subject: [PATCH] re-add installation to readme --- README.Rmd | 22 ++++++++++++++++++---- README.md | 23 +++++++++++++++++++---- 2 files changed, 37 insertions(+), 8 deletions(-) diff --git a/README.Rmd b/README.Rmd index 4ae4233..5b7538f 100644 --- a/README.Rmd +++ b/README.Rmd @@ -27,17 +27,31 @@ knitr::opts_chunk$set( VertNet.org API docs: -## Get started +## Installation -### [View vignette on ropensci](https://docs.ropensci.org/rvertnet/articles/rvertnet.html) +Stable CRAN version -### View vignette locally in your web browser +```{r eval=FALSE} +install.packages("rvertnet") +``` + +Development version from GitHub + +```{r eval=FALSE} +remotes::install_github("ropensci/rvertnet", build_vignettes = TRUE) +``` + +## [Get started](https://docs.ropensci.org/rvertnet/articles/rvertnet.html) + +[View vignette on ropensci website](https://docs.ropensci.org/rvertnet/articles/rvertnet.html) + +Or, view vignette locally in your web browser ```{r eval=FALSE} browseVignettes("rvertnet") ``` -### View vignette in Rstudio +Or, view vignette in the Rstudio help pane ```{r eval=FALSE} vignette("rvertnet") diff --git a/README.md b/README.md index b2f1f8d..e3ae469 100644 --- a/README.md +++ b/README.md @@ -24,17 +24,32 @@ version](https://www.r-pkg.org/badges/version/rvertnet)](https://cran.r-project. VertNet.org API docs: -## Get started +## Installation -### [View vignette on ropensci](https://docs.ropensci.org/rvertnet/articles/rvertnet.html) +Stable CRAN version -### View vignette locally in your web browser +``` r +install.packages("rvertnet") +``` + +Development version from GitHub + +``` r +remotes::install_github("ropensci/rvertnet", build_vignettes = TRUE) +``` + +## [Get started](https://docs.ropensci.org/rvertnet/articles/rvertnet.html) + +[View vignette on ropensci +website](https://docs.ropensci.org/rvertnet/articles/rvertnet.html) + +Or, view vignette locally in your web browser ``` r browseVignettes("rvertnet") ``` -### View vignette in Rstudio +Or, view vignette in the Rstudio help pane ``` r vignette("rvertnet")