Add link to vignette in README

mandymejia · Sep 30, 2020 · 9899970 · 9899970
1 parent ca35850
commit 9899970
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -40,3 +40,7 @@ devtools::install_github("mandymejia/clever")
 ```
 
 `clever` requires the `glmgen` package for PCA Trend Filtering (PCATF). Please see [https://github.com/glmgen/glmgen](https://github.com/glmgen/glmgen) for installation instructions.
+
+## Vignette
+
+You can view the vignette using this link: https://htmlpreview.github.io/?https://github.com/mandymejia/clever/blob/master/vignettes/vignette.html
diff --git a/README.md b/README.md
@@ -38,3 +38,8 @@ devtools::install_github("mandymejia/clever")
 `clever` requires the `glmgen` package for PCA Trend Filtering (PCATF).
 Please see <https://github.com/glmgen/glmgen> for installation
 instructions.
+
+## Vignette
+
+You can view the vignette using this link:
+<https://htmlpreview.github.io/?https://github.com/mandymejia/clever/blob/master/vignettes/vignette.html>