Update README.md

afsc-assessments · Dec 10, 2024 · afa6854 · afa6854
1 parent 53ecfd3
commit afa6854
Showing 1 changed file with 11 additions and 1 deletion.
diff --git 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/.