diff --git a/README.md b/README.md index 8178c76..de44fba 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -readme +# growthbreaks + +This package is designed to implement the GAM-based breakpoint detection method developed and tested in [Kapur et al. (2019)](https://www.sciencedirect.com/science/article/abs/pii/S0165783619302693). + +# Installation + +`remotes::install_github('afscassessments/growthbreaks')` + +# Vignettes +Check out the vignettes via `vignette('growthbreaks')` or read the Articles available at +https://afsc-assessments.github.io/growthbreaks/.