From b8865f7560538e16740ffafb3c8ddf8673a4642b Mon Sep 17 00:00:00 2001
From: hrbrmstr <bob@rudis.net>
Date: Fri, 9 Sep 2016 15:36:18 -0400
Subject: [PATCH] README

---
 R/htmltidy-package.r |  8 ++++++--
 README.Rmd           | 15 +++++++++++++++
 README.md            | 15 +++++++++++++++
 man/htmltidy.Rd      |  8 +++++---
 4 files changed, 41 insertions(+), 5 deletions(-)

diff --git a/R/htmltidy-package.r b/R/htmltidy-package.r
index 0fe48d0..7185f72 100644
--- a/R/htmltidy-package.r
+++ b/R/htmltidy-package.r
@@ -1,8 +1,12 @@
-#' Clean up gnarly HTML/XML
+#' Clean Up Gnarly HTML/XML
+#'
+#' HTML and XML documents can be beautiful and pristine. They can also be
+#' wretched, evil, malformed hellspawn. Now, you can tidy up that HTML and XML before
+#' processing it with your favorite angle-bracket parsing tools.
 #'
 #' @name htmltidy
 #' @docType package
-#' @author Bob Rudis (@@hrbrmstr)
+#' @author Bob Rudis (bob@@rud.is)
 #' @useDynLib htmltidy
 #' @importFrom Rcpp sourceCpp
 NULL
diff --git a/README.Rmd b/README.Rmd
index 058a670..5cfbccc 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -32,6 +32,21 @@ The following functions are implemented:
 
 - `tidy_html` : Clean up gnarly HTML/XML
 
+### TODO
+
+Fix:
+
+```{text}
+* checking compiled code ... WARNING
+File ‘htmltidy/libs/htmltidy.so’:
+  Found ‘___stderrp’, possibly from ‘stderr’ (C)
+    Objects: ‘alloc.o’, ‘streamio.o’, ‘tidylib.o’
+  Found ‘___stdoutp’, possibly from ‘stdout’ (C)
+    Objects: ‘sprtf.o’, ‘tidylib.o’
+  Found ‘_exit’, possibly from ‘exit’ (C)
+    Objects: ‘alloc.o’, ‘sprtf.o’
+```
+
 ### Installation
 
 ```{r eval=FALSE}
diff --git a/README.md b/README.md
index bdff89e..33f33ea 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,21 @@ The following functions are implemented:
 
 -   `tidy_html` : Clean up gnarly HTML/XML
 
+### TODO
+
+Fix:
+
+``` text
+* checking compiled code ... WARNING
+File ‘htmltidy/libs/htmltidy.so’:
+  Found ‘___stderrp’, possibly from ‘stderr’ (C)
+    Objects: ‘alloc.o’, ‘streamio.o’, ‘tidylib.o’
+  Found ‘___stdoutp’, possibly from ‘stdout’ (C)
+    Objects: ‘sprtf.o’, ‘tidylib.o’
+  Found ‘_exit’, possibly from ‘exit’ (C)
+    Objects: ‘alloc.o’, ‘sprtf.o’
+```
+
 ### Installation
 
 ``` r
diff --git a/man/htmltidy.Rd b/man/htmltidy.Rd
index 312131f..9562604 100644
--- a/man/htmltidy.Rd
+++ b/man/htmltidy.Rd
@@ -4,11 +4,13 @@
 \name{htmltidy}
 \alias{htmltidy}
 \alias{htmltidy-package}
-\title{Clean up gnarly HTML/XML}
+\title{Clean Up Gnarly HTML/XML}
 \description{
-Clean up gnarly HTML/XML
+HTML and XML documents can be beautiful and pristine. They can also be
+wretched, evil, malformed hellspawn. Now, you can tidy up that HTML and XML before
+processing it with your favorite angle-bracket parsing tools.
 }
 \author{
-Bob Rudis (@hrbrmstr)
+Bob Rudis (bob@rud.is)
 }