updated description in readme

README.Rmd

@@ -16,15 +16,15 @@ knitr::opts_chunk$set(
 )
 ```
 
-## *{{ packagename }}*: An R package with tools for estimating vaccine effectiveness and vaccine related metrics <img src="man/figures/logo.png" align="right" width="130"/>
+## *{{ packagename }}*: Tools for estimating vaccine effectiveness and vaccine related metrics <img src="man/figures/logo.png" align="right" width="130"/>
 
 <!-- badges: start -->
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)
 [![R-CMD-check](https://github.com/{{ gh_repo }}/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/{{ gh_repo }}/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/{{ gh_repo }}/branch/main/graph/badge.svg)](https://app.codecov.io/gh/{{ gh_repo }}?branch=main)
 [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
-[![lifecycle-experimental](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-experimental.svg)](https://www.reconverse.org/lifecycle.html#concept)
+[![lifecycle-maturing](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-maturing.svg)](https://www.reconverse.org/lifecycle.html#concept)
 
 <!-- badges: end -->
 
@@ -35,13 +35,25 @@ knitr::opts_chunk$set(
 
 ## Installation
 
-The current development version of _{{ packagename }}_ can be installed from [GitHub](https://github.com/) using the `pak` package.
+Our stable versions are released on CRAN, and can be installed using:
 
 ```r
+install.packages("vaccineff", build_vignettes = TRUE)
+```
+
+The current development version of _{{ packagename }}_ can be installed from [GitHub](https://github.com/) using the `pak` package.
+
+```{r, eval = FALSE}
 if(!require("pak")) install.packages("pak")
 pak::pak("{{ gh_repo }}")
 ```
 
+Or using the `remotes` package
+```{r, eval = FALSE }
+if(!require("remotes")) install.packages("remotes")
+remotes::install_github("{{ gh_repo }}")
+```
+
 ## Quick start
 
 ```{r cleaning, include = FALSE, echo = TRUE}
@@ -104,7 +116,7 @@ Contributors to the project include:
 **Authors**: [David Santiago Quevedo](https://github.com/davidsantiagoquevedo) and [Zulma M. Cucunubá](https://github.com/zmcucunuba) (maintainer)
 
 **Contributors**:
-[Geraldine Gómez](https://github.com/GeraldineGomez), [Pratik Gupte](https://github.com/pratikunterwegs), [Érika J. Cantor](https://github.com/ErikaCantor), [Santiago Loaiza](https://github.com/santilo9513), [Jaime A. Pavlich-Mariscal](https://github.com/jpavlich), [Hugo Gruson](https://github.com/Bisaloo), [Chris Hartgerink](https://github.com/chartgerink), [Felipe Segundo Abril-Bermúdez](https://github.com/fsabrilb)
+[Geraldine Gómez](https://github.com/GeraldineGomez), [Pratik Gupte](https://github.com/pratikunterwegs), [Érika J. Cantor](https://github.com/ErikaCantor), [Santiago Loaiza](https://github.com/santilo9513), [Jaime A. Pavlich-Mariscal](https://github.com/jpavlich), [Hugo Gruson](https://github.com/Bisaloo), [Chris Hartgerink](https://github.com/chartgerink), [Felipe Segundo Abril-Bermúdez](https://github.com/fsabrilb), [Joshua W. Lambert](https://github.com/joshwlambert), [Julian Otero](https://github.com/jd-otero)
 
 
 ## Code of conduct

README.md

@@ -1,5 +1,5 @@
 
-## *vaccineff*: An R package with tools for estimating vaccine effectiveness and vaccine related metrics <img src="man/figures/logo.png" align="right" width="130"/>
+## *vaccineff*: Tools for estimating vaccine effectiveness and vaccine related metrics <img src="man/figures/logo.png" align="right" width="130"/>
 
 <!-- badges: start -->
 
@@ -11,7 +11,7 @@ coverage](https://codecov.io/gh/epiverse-trace/vaccineff/branch/main/graph/badge
 [![Project Status: WIP – Initial development is in progress, but there
 has not yet been a stable, usable release suitable for the
 public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
-[![lifecycle-experimental](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-experimental.svg)](https://www.reconverse.org/lifecycle.html#concept)
+[![lifecycle-maturing](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-maturing.svg)](https://www.reconverse.org/lifecycle.html#concept)
 
 <!-- badges: end -->
 
@@ -30,6 +30,12 @@ screening method will be included in future versions.
 
 ## Installation
 
+Our stable versions are released on CRAN, and can be installed using:
+
+``` r
+install.packages("vaccineff", build_vignettes = TRUE)
+```
+
 The current development version of *vaccineff* can be installed from
 [GitHub](https://github.com/) using the `pak` package.
 
@@ -38,6 +44,13 @@ if(!require("pak")) install.packages("pak")
 pak::pak("epiverse-trace/vaccineff")
 ```
 
+Or using the `remotes` package
+
+``` r
+if(!require("remotes")) install.packages("remotes")
+remotes::install_github("epiverse-trace/vaccineff")
+```
+
 ## Quick start
 
 *vaccineff* provides a minimal cohort dataset that can be used to test
@@ -104,7 +117,7 @@ summary(ve)
 plot(ve, type = "loglog")
 ```
 
-<img src="man/figures/README-unnamed-chunk-2-1.png" width="100%" />
+<img src="man/figures/README-unnamed-chunk-4-1.png" width="100%" />
 
 ## Package vignettes
 
@@ -137,7 +150,9 @@ Loaiza](https://github.com/santilo9513), [Jaime A.
 Pavlich-Mariscal](https://github.com/jpavlich), [Hugo
 Gruson](https://github.com/Bisaloo), [Chris
 Hartgerink](https://github.com/chartgerink), [Felipe Segundo
-Abril-Bermúdez](https://github.com/fsabrilb)
+Abril-Bermúdez](https://github.com/fsabrilb), [Joshua W.
+Lambert](https://github.com/joshwlambert), [Julian
+Otero](https://github.com/jd-otero)
 
 ## Code of conduct