From 44d4a5aa986cae32dfb9513d0831fa30091d2235 Mon Sep 17 00:00:00 2001
From: David Landsman <Express50@users.noreply.github.com>
Date: Mon, 6 May 2019 15:07:27 -0400
Subject: [PATCH] Create README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c734929
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# omgee
+This R package provides an implementation of the GEE method for estimating multinomial probabilties for clustered data, for independent and exchangeable correlation structure. For more details about the methodology see [citation].
+
+## Installation
+There are a few methods available for installing the package. You need to have the `devtools` package installed to use these methods:
+```r
+> install.packages('devtools')
+```
+
+### Using GitHub
+Use the `install_github` method from devtools to install directly from this repository:
+```r
+> devtools::install_github('https://github.com/Express50/omgee')
+```
+
+### Using pre-built tar file
+Download the latest released .tar.gz file from the [Releases](https://github.com/Express50/omgee/releases) page into an empty folder. Then, navigate to the location of the file in your command line, and run the following from an R shell:
+```r
+> devtools::install('.', dependencies=TRUE)
+```
+
+## Building
+You can also build the code yourself by cloning the repository and using `R CMD BUILD`. Make sure to install the `rootSolve` dependecy before installing `omgee`, by running `install.packages('rootSolve')`
+```sh
+> git clone https://github.com/Express50/omgee omgee
+> R CMD build omgee
+> R CMD INSTALL omgee_1.0.tar.gz
+```