Generate HTML page showing how examples can be run

statwonk · Sep 20, 2015 · 0a6be1a · 0a6be1a
1 parent e867ded
commit 0a6be1a
Show file tree

Hide file tree

Showing 3 changed files with 178 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -28,6 +28,10 @@ library("openNHTSA")
 
 ## Examples
 
+The wrapper currently supports two facilities: [`complaints`](http://www.nhtsa.gov/webapi/Default.aspx?Complaints/Metadata/81) and [`recalls`](http://www.nhtsa.gov/webapi/Default.aspx?Recalls/Metadata/83). Here's an html document showing [how results of the examples should look](https://github.com/statwonk/openNHTSA/blob/master/README.Rmd).
+
+Complaints are reports filed by vehicle owners with the NHTSA.
+
 ```{r}
 complaints <- facility("complaints") %>%
   nhtsa_fetch()

diff --git a/README.html b/README.html
diff --git a/README.md b/README.md
@@ -28,6 +28,10 @@ library("openNHTSA")
 
 ## Examples
 
+The wrapper currently supports two facilities: [`complaints`](http://www.nhtsa.gov/webapi/Default.aspx?Complaints/Metadata/81) and [`recalls`](http://www.nhtsa.gov/webapi/Default.aspx?Recalls/Metadata/83). Here's an rmarkdown document showing [how results of the examples should look](https://github.com/statwonk/openNHTSA/blob/master/README.Rmd).
+
+Complaints are reports filed by vehicle owners with the NHTSA.
+
 ```{r}
 complaints <- facility("complaints") %>%
   nhtsa_fetch()