added basic readme

jraffa · Aug 23, 2020 · 80b338a · 80b338a
1 parent 476723f
commit 80b338a
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
 # rGOSSIS1
-The R package for the GOSSIS-1 ICU mortality predictor
+The R package for the GOSSIS-1 ICU mortality predictor.
+
+This repo is still in development.  We are currently working on making the code a little less brittle and improving documentation, particularly including some tutorials and examples.  Please make sure to use the most up to date version when using this package.
+
+To install:
+
+```
+install.packages("devtools")
+devtools::install_github('jraffa/rGOSSIS1')
+library(rGOSSIS1)
+```