diff --git a/.gitignore b/.gitignore index 6be57d6..bf2cfae 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .idea/ .Rproj.user -*.html \ No newline at end of file +hakaiApi/docs/*.html +!hakaiApi/pkgdown/templates/navbar.html \ No newline at end of file diff --git a/hakaiApi/README.md b/hakaiApi/README.md index 3f1562b..822e676 100644 --- a/hakaiApi/README.md +++ b/hakaiApi/README.md @@ -9,15 +9,16 @@ This project exports a single R6 class for the R programming language that can b ## Installation -Before using this library, install it into your environment using one of the following in your R script: +You can install hakaiApi from CRAN: ```r -# From CRAN install.packages("hakaiApi") +``` + +Or install the latest version from the Hakai Institute r-universe server: -# OR, the latest version from GitHub -install.packages("remotes") -remotes::install_github("HakaiInstitute/hakai-api-client-r", subdir='hakaiApi') +```r +install.packages("hakaiApi", repos = "https://hakaiinstitute.r-universe.dev") ``` ## Quickstart diff --git a/hakaiApi/_pkgdown.yml b/hakaiApi/_pkgdown.yml index 8257007..2d008b4 100644 --- a/hakaiApi/_pkgdown.yml +++ b/hakaiApi/_pkgdown.yml @@ -1,4 +1,10 @@ url: https://hakaiinstitute.github.io/hakai-api-client-r/ template: bootstrap: 5 + bootswatch: flatly + bslib: + primary: "#aa2025" + link-color: "#aa2025" + navbar-bg: "#2c3e50" + navbar-dark: true diff --git a/hakaiApi/pkgdown/assets/hakai.png b/hakaiApi/pkgdown/assets/hakai.png new file mode 100644 index 0000000..8133df3 Binary files /dev/null and b/hakaiApi/pkgdown/assets/hakai.png differ diff --git a/hakaiApi/pkgdown/templates/navbar.html b/hakaiApi/pkgdown/templates/navbar.html new file mode 100644 index 0000000..7be6f40 --- /dev/null +++ b/hakaiApi/pkgdown/templates/navbar.html @@ -0,0 +1,35 @@ +{{#navbar}} + +{{/navbar}}