Stub for README.md file.

README.md

@@ -1,25 +1,46 @@
+[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/scythe)](https://cran.r-project.org/package=scythe)
+[![Build Status](https://travis-ci.org/DataONEorg/scythe.png?branch=master)](https://travis-ci.org/DataONEorg/scythe)
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
 
-# scythe
+- **Authors**: TBD
+- [doi:10.5063/______________](http://doi.org/10.5063/_______________)
+- **License**: [Apache 2](http://opensource.org/licenses/Apache-2.0)
+- [Package source code on Github](https://github.com/DataONEorg/scythe)
+- [**Submit Bugs and feature requests**](https://github.com/DataONEorg/scythe/issues)
 
-<!-- badges: start -->
-<!-- badges: end -->
+Automates the full text harvesting of dataset citations from various full text article databases, 
+including Scopus, PLOS, and Pubmed Central.
 
-The goal of scythe is to ...
+## Installation 
 
-## Installation
+### Released version
 
-You can install the released version of scythe from [CRAN](https://CRAN.R-project.org) with:
-
-``` r
+```
 install.packages("scythe")
 ```
 
-## Example
+The *scythe* R package should be available for use at this point.
+
+### Development version
 
-This is a basic example which shows you how to solve a common problem:
+Development versions can be installed from GitHub.
+
+```
+remotes::install_github("DataONEorg/scythe@develop")
+```
 
-``` r
+## Quick Start
+
+TBD...
+
+```
 library(scythe)
-## basic example code
+# R example goes here
 ```
 
+## Acknowledgments
+Work on this package was supported by:
+
+- NSF-PLR grant #1546024 to M. B. Jones, S. Baker-Yeboah, J. Dozier, M. Schildhauer, and A. Budden
+
+[![nceas_footer](https://www.nceas.ucsb.edu/files/newLogo_0.png)](http://www.nceas.ucsb.edu)