Skip to content

Commit 136d421

Browse files
committed
docs: update README
1 parent c9be84b commit 136d421

File tree

3 files changed

+11
-22
lines changed

3 files changed

+11
-22
lines changed

README.Rmd

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,11 @@ knitr::knit_hooks$set(margin = function(before, options, envir) {
2020

2121
# maptiles <img src="man/figures/logo.png" align="right" width="140"/>
2222

23-
<!-- badges: start -->
2423
[![R-CMD-check](https://github.com/riatelab/maptiles/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/riatelab/maptiles/actions/workflows/R-CMD-check.yaml)
25-
[![Codecov test coverage](https://codecov.io/gh/riatelab/maptiles/graph/badge.svg)](https://app.codecov.io/gh/riatelab/maptiles)
24+
[![codecov](https://codecov.io/gh/riatelab/maptiles/branch/dev/graph/badge.svg?token=R7T2PCTERH)](https://app.codecov.io/github/riatelab/maptiles)
2625
[![CRAN status](https://www.r-pkg.org/badges/version/maptiles)](https://CRAN.R-project.org/package=maptiles)
2726
![](https://cranlogs.r-pkg.org/badges/maptiles)
28-
[![Project Status: Active – The project has reached a stable, usable
29-
state and is being actively
30-
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
31-
<!-- badges: end -->
27+
3228

3329
To create maps from tiles, `maptiles` downloads, composes and displays tiles
3430
from a large number of providers (e.g. OpenStreetMap, Stadia, Esri, CARTO, or
@@ -42,11 +38,10 @@ You can install the released version of `maptiles` from [CRAN](https://CRAN.R-pr
4238
install.packages("maptiles")
4339
```
4440

45-
You can install the development version of `maptiles` from GitHub with:
41+
Alternatively, you can install the development version of `osrm` (the dev branch) from [r-universe](https://riatelab.r-universe.dev/maptiles) with:
4642

4743
``` r
48-
# install.packages("remotes")
49-
remotes::install_github("riatelab/maptiles")
44+
install.packages('maptiles', repos = 'https://riatelab.r-universe.dev')
5045
```
5146

5247
## Demo

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,11 @@
33

44
# maptiles <img src="man/figures/logo.png" align="right" width="140"/>
55

6-
<!-- badges: start -->
7-
86
[![R-CMD-check](https://github.com/riatelab/maptiles/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/riatelab/maptiles/actions/workflows/R-CMD-check.yaml)
9-
[![Codecov test
10-
coverage](https://codecov.io/gh/riatelab/maptiles/graph/badge.svg)](https://app.codecov.io/gh/riatelab/maptiles)
7+
[![codecov](https://codecov.io/gh/riatelab/maptiles/branch/dev/graph/badge.svg?token=R7T2PCTERH)](https://app.codecov.io/github/riatelab/maptiles)
118
[![CRAN
129
status](https://www.r-pkg.org/badges/version/maptiles)](https://CRAN.R-project.org/package=maptiles)
13-
![](https://cranlogs.r-pkg.org/badges/maptiles) [![Project Status:
14-
Active – The project has reached a stable, usable state and is being
15-
actively
16-
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
17-
<!-- badges: end -->
10+
![](https://cranlogs.r-pkg.org/badges/maptiles)
1811

1912
To create maps from tiles, `maptiles` downloads, composes and displays
2013
tiles from a large number of providers (e.g. OpenStreetMap, Stadia,
@@ -29,11 +22,12 @@ You can install the released version of `maptiles` from
2922
install.packages("maptiles")
3023
```
3124

32-
You can install the development version of `maptiles` from GitHub with:
25+
Alternatively, you can install the development version of `osrm` (the
26+
dev branch) from [r-universe](https://riatelab.r-universe.dev/maptiles)
27+
with:
3328

3429
``` r
35-
# install.packages("remotes")
36-
remotes::install_github("riatelab/maptiles")
30+
install.packages('maptiles', repos = 'https://riatelab.r-universe.dev')
3731
```
3832

3933
## Demo
@@ -80,7 +74,7 @@ nc_osmpos <- get_tiles(
8074
)
8175
#> Zoom: 7
8276
#> Source(s): © OpenStreetMap contributors © CARTO
83-
#> Cache directory: /tmp/RtmpLSQP7d/CARTO.POSITRON
77+
#> Cache directory: /tmp/Rtmp1Uv7sr/CARTO.POSITRON
8478
#> 8 tiles
8579
#> The resulting raster uses high resolution tiles.
8680
# display map

man/figures/README-example-1.png

-32 Bytes
Loading

0 commit comments

Comments
 (0)