Skip to content

Commit

Permalink
docs: use r-multiverse repo instead of rpolars repo for installing th…
Browse files Browse the repository at this point in the history
…e latest release version (#1159)
  • Loading branch information
eitsupi authored Jul 5, 2024
1 parent 1e2566b commit 051f7e7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
5 changes: 3 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ knitr::opts_chunk$set(
# polars

<!-- badges: start -->
[![R-multiverse status](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fcommunity.r-multiverse.org%2Fapi%2Fpackages%2Fpolars&query=%24.Version&label=r-multiverse)](https://community.r-multiverse.org/polars)
[![R-universe status badge](https://rpolars.r-universe.dev/badges/polars)](https://rpolars.r-universe.dev)
[![CRAN status](https://www.r-pkg.org/badges/version/polars)](https://CRAN.R-project.org/package=polars)
[![Dev R-CMD-check](https://github.com/pola-rs/r-polars/actions/workflows/check.yaml/badge.svg)](https://github.com/pola-rs/r-polars/actions/workflows/check.yaml)
Expand Down Expand Up @@ -54,11 +55,11 @@ when updating `polars`.

## Install

The recommended way to install this package is via R-universe:
The recommended way to install this package is via R-multiverse:

```r
Sys.setenv(NOT_CRAN = "true")
install.packages("polars", repos = "https://rpolars.r-universe.dev")
install.packages("polars", repos = "https://r-multiverse.r-universe.dev")
```

[The "Install" vignette](https://pola-rs.github.io/r-polars/vignettes/install.html) (`vignette("install", "polars")`)
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

<!-- badges: start -->

[![R-multiverse
status](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fcommunity.r-multiverse.org%2Fapi%2Fpackages%2Fpolars&query=%24.Version&label=r-multiverse)](https://community.r-multiverse.org/polars)
[![R-universe status
badge](https://rpolars.r-universe.dev/badges/polars)](https://rpolars.r-universe.dev)
[![CRAN
Expand Down Expand Up @@ -45,11 +47,11 @@ breaking changes at each version. Be sure to check the

## Install

The recommended way to install this package is via R-universe:
The recommended way to install this package is via R-multiverse:

``` r
Sys.setenv(NOT_CRAN = "true")
install.packages("polars", repos = "https://rpolars.r-universe.dev")
install.packages("polars", repos = "https://r-multiverse.r-universe.dev")
```

[The “Install”
Expand Down
4 changes: 2 additions & 2 deletions vignettes/install.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Installing the latest release version.

```r
Sys.setenv(NOT_CRAN = "true") # Enable installation with pre-built Rust library binary, or enable Rust caching
install.packages("polars", repos = "https://rpolars.r-universe.dev")
install.packages("polars", repos = "https://r-multiverse.r-universe.dev")
```

- On supported platforms, binary R package will be installed.
Expand Down Expand Up @@ -111,7 +111,7 @@ For example (on Bash):
```sh
export LIBR_POLARS_BUILD="false"
export LIBR_POLARS_PATH="/tmp/libr_polars.a"
Rscript -e 'install.packages("polars", repos = "https://rpolars.r-universe.dev", type = "source")'
Rscript -e 'install.packages("polars", repos = "https://r-multiverse.r-universe.dev", type = "source")'
```

### Rust build time options
Expand Down

0 comments on commit 051f7e7

Please sign in to comment.