Skip to content

Commit

Permalink
docs: update installation instruction after CRAN release
Browse files Browse the repository at this point in the history
  • Loading branch information
vidonne committed Jan 17, 2025
1 parent 59c1c59 commit 4ca5753
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 8 deletions.
3 changes: 0 additions & 3 deletions CRAN-SUBMISSION

This file was deleted.

12 changes: 9 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ knitr::opts_chunk$set(
<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/unhcr-dataviz/unhcrdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/unhcr-dataviz/unhcrdown/actions/workflows/R-CMD-check.yaml)
<!-- [![CRAN status](https://www.r-pkg.org/badges/version/unhcrdown)](https://CRAN.R-project.org/package=unhcrdown) -->
[![CRAN status](https://www.r-pkg.org/badges/version/unhcrdown)](https://CRAN.R-project.org/package=unhcrdown)
<!-- badges: end -->

Streamline your document creation process with the `{unhcrdown}` R package. It provides a comprehensive set of templates designed to align your reports and presentations with **UNHCR's brand guidelines**. This package offers ready-to-use R Markdown templates for various document types, ensuring consistent UNHCR visual identity across your communications.
Expand All @@ -32,9 +32,15 @@ Streamline your document creation process with the `{unhcrdown}` R package. It p

## Installation

Get started by installing the development version from GitHub with:
Get started by installing the `{unhcrdown}` package from CRAN with:

```{r, eval = FALSE}
```{r install, eval=FALSE}
install.packages("unhcrdown")
```

Or retrieve the development version from Github using the `{pak}` package:

```{r pak, eval=FALSE}
# If pak is not yet installed, uncomment the following line:
# install.packages("pak")
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
[![Lifecycle:
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/unhcr-dataviz/unhcrdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/unhcr-dataviz/unhcrdown/actions/workflows/R-CMD-check.yaml)
<!-- [![CRAN status](https://www.r-pkg.org/badges/version/unhcrdown)](https://CRAN.R-project.org/package=unhcrdown) -->
[![CRAN
status](https://www.r-pkg.org/badges/version/unhcrdown)](https://CRAN.R-project.org/package=unhcrdown)
<!-- badges: end -->

Streamline your document creation process with the `{unhcrdown}` R
Expand All @@ -28,7 +29,14 @@ communications.

## Installation

Get started by installing the development version from GitHub with:
Get started by installing the `{unhcrdown}` package from CRAN with:

``` r
install.packages("unhcrdown")
```

Or retrieve the development version from Github using the `{pak}`
package:

``` r
# If pak is not yet installed, uncomment the following line:
Expand Down

0 comments on commit 4ca5753

Please sign in to comment.