1 files changed, 35 insertions(+), 24 deletions(-)

M README.md

@@ 1,20 1,45 @@
 
-`hgr` : Tools to Work with the 'Postlight' 'Mercury' 'API'
+[![Travis-CI Build
+Status](https://travis-ci.org/hrbrmstr/hgr.svg?branch=master)](https://travis-ci.org/hrbrmstr/hgr)
+\* Turn on travis for your repo at <https://travis-ci.org/hrbrmstr/hgr>
+[![AppVeyor Build
+Status](https://ci.appveyor.com/api/projects/status/github/hrbrmstr/hgr?branch=master&svg=true)](https://ci.appveyor.com/project/hrbrmstr/hgr)
+[![Coverage
+Status](https://img.shields.io/codecov/c/github/hrbrmstr/hgr/master.svg)](https://codecov.io/github/hrbrmstr/hgr?branch=master)
 
-Mercury takes any web article and returns only the relevant content — headline, author, body text, relevant images and more — free from any clutter. You need an API key which you can get from [here](https://mercury.postlight.com).
+# hgr
+
+Tools to Work with the ‘Postlight’ ‘Mercury’ ‘API’
+
+## Description
+
+The ‘Postlight’ ‘Mercury’ ‘API’ <https://mercury.postlight.com> takes
+any web article and returns only the relevant content - headline,
+author, body text, images and more - free from any clutter and including
+only minimal markup. Tools are provided to access the ‘API’ and also
+further clean up retrieved text through the the application of ‘XSLT’
+style sheets. An ‘RStudio’ ‘Addin’ is also provided which makes it
+possible to preview the cleaned content from a ‘URL’ on the clipboard.
+
+You need an API key which you can get from
+[here](https://mercury.postlight.com).
+
+## What’s inside the tin?
 
 The following functions are implemented:
 
--   `just_the_facts`: Retrieve parsed content of a URL processed by the Postlight Mercury API
--   `clean_text`: Remove all HTML/XML tags from an HTML document/atomic character vector
+  - `just_the_facts`: Retrieve parsed content of a URL processed by the
+    Postlight Mercury API
+  - `clean_text`: Remove all HTML/XML tags from an HTML document/atomic
+    character vector
 
-### Installation
+## Installation
 
 ``` r
 devtools::install_github("hrbrmstr/hgr")
 ```
 
-### Usage
+## Usage
 
 ``` r
 library(hgr)


@@ 63,22 88,8 @@ substr(plain, 1, 100)
 
     ## [1] "WASHINGTON — Just over a week ago, the White House declared that ordering an American aircraft carri"
 
-### Test Results
-
-``` r
-library(hgr)
-library(testthat)
-
-date()
-```
-
-    ## [1] "Wed Sep 13 14:44:54 2017"
-
-``` r
-test_dir("tests/")
-```
+## Code of Conduct
 
-    ## testthat results ========================================================================================================
-    ## OK: 1 SKIPPED: 0 FAILED: 0
-    ## 
-    ## DONE ===================================================================================================================
+Please note that this project is released with a [Contributor Code of
+Conduct](CONDUCT.md). By participating in this project you agree to
+abide by its terms.