Merge pull request #3 from Sage-Bionetworks/develop

Update readme

Author: Kenneth Daily

README.md

@@ -1,3 +1,27 @@
 ## Information
 
-Usage statistics for LINCS.
+Generate HTML usage reports for Synapse projects.
+
+## Requirements
+
+1. R >= 3.3.0
+1. RStudio
+1. [rSynapseClient](https://www.github.com/Sage-Bionetworks/rSynapseClient)
+
+## Installation
+
+Clone this repository and install the following packages:
+
+```
+install.packages("shiny", "rmarkdown", "plyr", "dplyr", "reshape", "data.table", "xtable", "knitr", "ggplot2", "scales", "stringr", "synapseClient", "RMySQL", "yaml", "lubridate")
+```
+
+## Usage
+
+Set your working directory to the root of the project and run the Shiny app at `inst/shiny-apps/UsageStats/app.R`:
+
+```
+shiny::runApp('inst/shiny-apps/UsageStats/', launch.browser=TRUE)
+```
+
+Select "launch in browser" either from the running app