Skip to content

Commit

Permalink
Update installation instructions (#696)
Browse files Browse the repository at this point in the history
  • Loading branch information
maurolepore authored Jan 19, 2024
1 parent 4d66240 commit a239b9c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
9 changes: 5 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,27 @@ knitr::opts_chunk$set(
# tiltIndicator

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![tiltIndicator status badge](https://2degreesinvesting.r-universe.dev/badges/tiltIndicator)](https://2degreesinvesting.r-universe.dev/tiltIndicator)
[![R-CMD-check](https://github.com/2DegreesInvesting/tiltIndicator/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/2DegreesInvesting/tiltIndicator/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/2DegreesInvesting/tiltIndicator/branch/main/graph/badge.svg)](https://app.codecov.io/gh/2DegreesInvesting/tiltIndicator?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->

The goal of tiltIndicator is to implement the core business logic of the 'TILT'
indicators.

## Installation

You can install the development version from
[r-universe](https://r-universe.dev/):
You can install the latest release from [r-universe](https://r-universe.dev/)
with:

``` r
# install.packages("pak")
pak::repo_add(r_universe = "https://2degreesinvesting.r-universe.dev")
install.packages("tiltIndicator")
```

Or from [GitHub](https://github.com/):
Or the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,30 @@

<!-- badges: start -->

[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![tiltIndicator status
badge](https://2degreesinvesting.r-universe.dev/badges/tiltIndicator)](https://2degreesinvesting.r-universe.dev/tiltIndicator)
[![R-CMD-check](https://github.com/2DegreesInvesting/tiltIndicator/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/2DegreesInvesting/tiltIndicator/actions/workflows/R-CMD-check.yaml)
[![Codecov test
coverage](https://codecov.io/gh/2DegreesInvesting/tiltIndicator/branch/main/graph/badge.svg)](https://app.codecov.io/gh/2DegreesInvesting/tiltIndicator?branch=main)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->

The goal of tiltIndicator is to implement the core business logic of the
‘TILT’ indicators.

## Installation

You can install the development version from
[r-universe](https://r-universe.dev/):
You can install the latest release from
[r-universe](https://r-universe.dev/) with:

``` r
# install.packages("pak")
pak::repo_add(r_universe = "https://2degreesinvesting.r-universe.dev")
install.packages("tiltIndicator")
```

Or from [GitHub](https://github.com/):
Or the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
Expand Down

0 comments on commit a239b9c

Please sign in to comment.