Skip to content

Commit

Permalink
update readme (#777)
Browse files Browse the repository at this point in the history
- remove r-universe from install instructions for simplicity
- remove r-universe link - this fixes url-checker
- add reference to the introduction article
  • Loading branch information
pawelru authored Aug 28, 2024
1 parent 45eaf8f commit ee0c6db
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,19 @@ Please see [`teal` gallery](https://github.com/insightsengineering/teal.gallery)
## Installation

```r
# stable versions
install.packages('teal.modules.general')

# install.packages("pak")
pak::pak("insightsengineering/teal.modules.general@*release")
```

Alternatively, you might want to use the development version available on [r-universe](https://r-universe.dev/).
Alternatively, you might want to use the development version.

```r
# beta versions
install.packages('teal.modules.general', repos = c('https://pharmaverse.r-universe.dev', getOption('repos')))

# install.packages("pak")
pak::pak("insightsengineering/teal.modules.general")
```

## Usage

See package vignettes `browseVignettes(package = "teal.modules.general")` for usage of this package or visit [Package Website](https://insightsengineering.github.io/teal.modules.general/latest-tag/).
To understand how to use this package, please refer to the [Getting Started](https://insightsengineering.github.io/teal.modules.general/latest-tag/articles/teal-modules-general.html) article, which provides multiple examples of code implementation.

## Getting help

Expand Down

0 comments on commit ee0c6db

Please sign in to comment.