Skip to content

Commit

Permalink
update readme (#1290)
Browse files Browse the repository at this point in the history
- use `pak` for install instructions
- remove section about PAT as unrelated
- add reference to the intro article
  • Loading branch information
pawelru committed Aug 28, 2024
1 parent 70d0298 commit dba2aab
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,13 @@ install.packages("tern")
or you can install the latest development version directly from GitHub by running the following:

```r
if (!require("remotes")) install.packages("remotes")
remotes::install_github("insightsengineering/tern")
# install.packages("pak")
pak::pak("insightsengineering/tern")
```

Note that it is recommended you [create and use a `GITHUB_PAT`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) if installing from GitHub.
## Usage

To understand how to use this package, please refer to the [Introduction to `tern`](https://insightsengineering.github.io/tern/latest-tag/articles/tern.html) article, which provides multiple examples of code implementation.

See package vignettes `browseVignettes(package = "tern")` for usage of this package.

Expand Down

0 comments on commit dba2aab

Please sign in to comment.