From 2235ae62a0798f011cb7cc1a89fa3b674d37e7c9 Mon Sep 17 00:00:00 2001 From: Andrea Manica Date: Tue, 14 Nov 2023 06:56:10 +0000 Subject: [PATCH] Update readme --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0632b01e..8cb4f730 100644 --- a/README.md +++ b/README.md @@ -26,19 +26,24 @@ An overview of the capabilities of `tidysdm` is given in [Leonardi et al. ## Installation -`tidysdm` is still at the **beta** stage of development, and there is no official release on -CRAN yet. +`tidysdm` is on CRAN, and the easiest way to install it is with: -You can install the latest version of tidysdm from [GitHub](https://github.com/) with: - -``` r -# install.packages("devtools") -devtools::install_github("EvolEcolGroup/tidysdm") +``` +install.packages("tidysdm") ``` -For the development version of `tidysdm`, which includes experimental features -that might not be mature yet, use: +The version on CRAN is recommended for every day use. New features and +bug fixes appear first on the `dev` branch on GitHub, before they make +their way to CRAN. If you need to have early access to these new +features, you can install `tidysdm` directly from GitHub. To install +from GitHub, you will need to use `devtools`; if you haven't done so +already, get it from CRAN with `install.packages("devtools")`. + + +You can install the latest `dev` version of tidysdm from [GitHub](https://github.com/) with: + ``` r +# install.packages("devtools") devtools::install_github("EvolEcolGroup/tidysdm", ref = "dev") ```