From b4dd1176ccbff2eaed672373d3f5e3c45c8723c9 Mon Sep 17 00:00:00 2001
From: Tomrrr1 <76951517+Tomrrr1@users.noreply.github.com>
Date: Tue, 16 Apr 2024 09:33:16 +0100
Subject: [PATCH] Add installation instructions to the README.

---
 README.Rmd | 11 +++++++++++
 README.md  | 15 +++++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/README.Rmd b/README.Rmd
index 0d4aaee..a3a789a 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -8,3 +8,14 @@ output: github_document
 ## MotifStats
 
 `MotifStats` is an R package for calculating metrics that quantify the relationship between peaks and motifs.
+
+## Installation
+
+`MotifStats` is available through GitHub. It can be installed using the following commands.
+
+```R
+if(!require("remotes")) install.packages("remotes")
+remotes::install_github("neurogenomics/MotifStats")
+```
+
+`MotifStats` lists [MEME suite](https://meme-suite.org/meme/index.html) as a system dependency. Directions for installation can be found [here](https://www.bioconductor.org/packages/release/bioc/vignettes/memes/inst/doc/install_guide.html).
diff --git a/README.md b/README.md
index db91e9a..63322b9 100644
--- a/README.md
+++ b/README.md
@@ -16,3 +16,18 @@ Authors: <i>Thomas Roberts</i>
 
 `MotifStats` is an R package for calculating metrics that quantify the
 relationship between peaks and motifs.
+
+## Installation
+
+`MotifStats` is available through GitHub. It can be installed using the
+following commands.
+
+``` r
+if(!require("remotes")) install.packages("remotes")
+remotes::install_github("neurogenomics/MotifStats")
+```
+
+`MotifStats` requires [MEME
+suite](https://meme-suite.org/meme/index.html) as a system dependency.
+Directions for installation can be found
+[here](https://www.bioconductor.org/packages/release/bioc/vignettes/memes/inst/doc/install_guide.html).