docs: add links to docs website in README

.github/workflows/auto-format.yml

@@ -33,7 +33,6 @@ jobs:
         shell: Rscript {0}
         run: |
           rmarkdown::render("README.Rmd")
-          if (file.exists("README.html")) file.remove("README.html")
 
       - name: update CITATION.cff
         shell: Rscript {0}

.gitignore

@@ -8,3 +8,4 @@ docs
 inst/doc
 /doc/
 /Meta/
+/README.html

README.Rmd

@@ -25,22 +25,31 @@ R package for downstream multi-omics analysis
 
 Designed for differential [RNA-seq](https://github.com/CCBR/RENEE) analysis
 or any data represented in a counts table.
+See the website for more information, documentation, and examples:
+<https://ccbr.github.io/MOSuite/>
 
 ## Installation
 
-You can install the development version of MOSuite from [GitHub](https://github.com/) with:
+You can install the development version of MOSuite from [GitHub](https://github.com/CCBR/MOSuite) with:
 
 ```r
 # install.packages("devtools")
 devtools::install_github("CCBR/MOSuite")
 ```
 
+## Usage
+
+Please see the [introductory vignette](https://ccbr.github.io/MOSuite/articles/intro.html)
+for a quick start tutorial.
+Take a look at the [reference documentation](https://ccbr.github.io/MOSuite/reference/index.html)
+for detailed information on each function in the package.
+
 <!--
 ## Example
 
 TODO: This is a basic example which shows you how to solve a common problem:
 
-```{r example}
+```{r example, message=FALSE, warning=FALSE}
 library(MOSuite)
 ## basic example code
 ```

README.md

@@ -12,26 +12,34 @@
 R package for downstream multi-omics analysis
 
 Designed for differential [RNA-seq](https://github.com/CCBR/RENEE)
-analysis or any data represented in a counts table.
+analysis or any data represented in a counts table. See the website for
+more information, documentation, and examples:
+<https://ccbr.github.io/MOSuite/>
 
 ## Installation
 
 You can install the development version of MOSuite from
-[GitHub](https://github.com/) with:
+[GitHub](https://github.com/CCBR/MOSuite) with:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github("CCBR/MOSuite")
 ```
 
+## Usage
+
+Please see the [introductory
+vignette](https://ccbr.github.io/MOSuite/articles/intro.html) for a
+quick start tutorial. Take a look at the [reference
+documentation](https://ccbr.github.io/MOSuite/reference/index.html) for
+detailed information on each function in the package.
+
 <!--
 ## Example
 &#10;TODO: This is a basic example which shows you how to solve a common problem:
 &#10;
 ``` r
 library(MOSuite)
-#> Warning: replacing previous import 'S4Arrays::makeNindexFromArrayViewport' by
-#> 'DelayedArray::makeNindexFromArrayViewport' when loading 'SummarizedExperiment'
 ## basic example code
 ```
 -->