docs: readme setup

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
         args:
           - --unsafe
       - id: end-of-file-fixer
-        exclude: \.Rd$
+        exclude: \.Rd
       - id: file-contents-sorter
         files: ^\.Rbuildignore$
       - id: trailing-whitespace
@@ -17,8 +17,10 @@ repos:
       - id: roxygenize
         additional_dependencies:
           - httr2
+          - xml2
       - id: deps-in-desc
       - id: no-browser-statement
+      - id: no-debug-statement
       - id: parsable-R
       - id: style-files
       - id: readme-rmd-rendered

README.Rmd

@@ -7,7 +7,9 @@ output: github_document
 ```{r, include = FALSE}
 knitr::opts_chunk$set(
   collapse = TRUE,
-  comment = "#>"
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
 )
 ```
 
@@ -18,7 +20,7 @@ knitr::opts_chunk$set(
 [![R-CMD-check](https://github.com/m-muecke/bundesbank/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/m-muecke/bundesbank/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-The goal of bundesbank is to provide a simple interface to the ...
+The goal of bundesbank is to provide a simple interface to the [Bundesbank time series database API](https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service).
 
 ## Installation
 You can install the development version of bundesbank from [GitHub](https://github.com/) with:

README.md

@@ -10,7 +10,9 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
 [![R-CMD-check](https://github.com/m-muecke/bundesbank/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/m-muecke/bundesbank/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-The goal of bundesbank is to provide a simple interface to the …
+The goal of bundesbank is to provide a simple interface to the
+[Bundesbank time series database
+API](https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service).
 
 ## Installation