docs: update installation instructions

GIScience · Oct 18, 2024 · 0378e2f · 0378e2f
1 parent 4efa4f5
commit 0378e2f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -45,8 +45,15 @@ conditions](https://openrouteservice.org/terms-of-service/).
 
 ## Installation
 
-The package is not yet available from CRAN, but you can install the
-development version directly from GitHub.
+The latest release version can be readily obtained from CRAN via a call
+to
+
+    install.packages("openrouteservice")
+
+For running the current development version from GitHub it is
+recommended to use [pak](https://CRAN.R-project.org/package=pak), as it
+handles the installation of all the necessary packages and their system
+dependencies automatically.
 
     # install.packages("pak")
     pak::pak("GIScience/openrouteservice-r")

diff --git a/vignettes/openrouteservice.Rmd b/vignettes/openrouteservice.Rmd
@@ -49,8 +49,15 @@ conditions](https://openrouteservice.org/terms-of-service/).
 
 ### Installation
 
-The package is not yet available from CRAN, but you can install the
-development version directly from GitHub.
+The latest release version can be readily obtained from CRAN via a call to
+
+```{r cran, eval=FALSE}
+install.packages("openrouteservice")
+```
+
+For running the current development version from GitHub it is recommended to use
+[pak](https://CRAN.R-project.org/package=pak), as it handles the installation of
+all the necessary packages and their system dependencies automatically.
 
 ```{r installation, eval=FALSE}
 # install.packages("pak")