From aaeeec121d24bfb892af5f1f975da5a4f6b94faa Mon Sep 17 00:00:00 2001
From: boB Rudis <bob@rudis.net>
Date: Fri, 12 Aug 2016 18:17:30 -0400
Subject: [PATCH] readme

---
 README.Rmd |  6 +++++-
 README.md  | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.Rmd b/README.Rmd
index 3e913ed..12b6466 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -2,12 +2,16 @@
 output: rmarkdown::github_document
 ---
 
-`filemagic` : ...
+`filemagic` : R interface to libmagic
 
 The following functions are implemented:
 
+- `get_mimetype` : returns the mimetype of the files in the input vector (as a data frame)
+
 The following data sets are included:
 
+- (eventually will be an internal mime types db)
+
 ### Installation
 
 ```{r eval=FALSE}
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95ef6bb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+
+`filemagic` : R interface to libmagic
+
+The following functions are implemented:
+
+-   `get_mimetype` : returns the mimetype of the files in the input vector (as a data frame)
+
+The following data sets are included:
+
+-   (eventually will be an internal mime types db)
+
+### Installation
+
+``` r
+devtools::install_github("hrbrmstr/filemagic")
+```
+
+### Usage
+
+``` r
+library(filemagic)
+
+# current verison
+packageVersion("filemagic")
+```
+
+    ## [1] '0.1.0'
+
+### Test Results
+
+``` r
+library(filemagic)
+library(testthat)
+
+date()
+```
+
+    ## [1] "Fri Aug 12 18:16:56 2016"
+
+``` r
+test_dir("tests/")
+```
+
+    ## testthat results ========================================================================================================
+    ## OK: 0 SKIPPED: 0 FAILED: 0
+    ## 
+    ## DONE ===================================================================================================================