R/rjsonapi-package.R

In rjsonapi: Consumer for APIs that Follow the JSON API Specification

#' rjsonapi client
#'
#' @importFrom jsonlite fromJSON
#' @importFrom R6 R6Class
#' @importFrom plumber plumb
#' @name rjsonapi-package
#' @aliases rjsonapi
#' @docType package
#' @author Scott Chamberlain \email{myrmecocystus@@gmail.com}
#' @keywords package
#'
#' @section JSON API:
#' JSON API is a specification for building APIs (Application Programming
#' Interfaces) in JSON (Javascript Object Notation).
#'
#' The JSON API website is at \url{http://jsonapi.org/}. The specification
#' itself is at \url{http://jsonapi.org/format/}, with implementations at
#' \url{http://jsonapi.org/implementations/}.
#'
#' @section Examples:
#' There are very few examples to see in the real world. One example
#' comes from CodeClimate. Their API docs are at
#' https://docs.codeclimate.com/docs/api
NULL