fix #9 add link to api faq in readme/pkg level man file

R/jaod-package.R

@@ -9,6 +9,8 @@
 #' reviewed open access material."
 #'
 #' DOAJ API documentation can be found at <https://doaj.org/api/v1/docs>.
+#' 
+#' DOAJ API FAQ: <https://doaj.org/faq#apikey>
 #'
 #' @section Package API:
 #' * [jaod_article()] - Get an article by ID

README.Rmd

@@ -19,6 +19,8 @@ knitr::opts_chunk$set(
 
 `jaod` - R client for [Directory of Open Access Journals API](https://doaj.org/api/v1/docs)
 
+DOAJ API FAQ: <https://doaj.org/faq#apikey>
+
 get started with the package docs: <https://ropensci.github.io/jaod/>
 
 ## installation

README.md

@@ -12,6 +12,8 @@ jaod
 
 `jaod` - R client for [Directory of Open Access Journals API](https://doaj.org/api/v1/docs)
 
+DOAJ API FAQ: <https://doaj.org/faq#apikey>
+
 get started with the package docs: <https://ropensci.github.io/jaod/>
 
 ## installation
@@ -41,7 +43,7 @@ library("jaod")
 ```r
 jaod_journal_search(query = "bibjson.keywords:heritage")
 #> $timestamp
-#> [1] "2019-09-04T16:53:21.260315Z"
+#> [1] "2019-09-04T16:58:15.006551Z"
 #> 
 #> $page
 #> [1] 1
@@ -158,7 +160,7 @@ out$bibjson$author_publishing_rights
 ```r
 jaod_article_search(query = "license:CC-BY")
 #> $timestamp
-#> [1] "2019-09-04T16:53:22.366669Z"
+#> [1] "2019-09-04T16:58:15.841886Z"
 #> 
 #> $page
 #> [1] 1