Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vidonne committed Sep 28, 2023
1 parent fa52b1c commit 19c3913
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ pak::pkg_install("unhcr-dataviz/cccmthemes")

## Usage

```{r load, message = FALSE, warning = FALSE, eval=FALSE}
```{r load, message = FALSE, warning = FALSE}
# Load required packages
library(ggplot2)
library(cccmthemes)
```

### Base `{ggplot2}` theme

```{r base-plot, message = FALSE, warning = FALSE, out.width="90%", fig.align="center", eval=FALSE}
```{r base-plot, message = FALSE, warning = FALSE, out.width="90%", fig.align="center"}
# Apply the theme_unhcr() to your plot
ggplot(
mtcars,
Expand All @@ -63,7 +63,7 @@ ggplot(

### Font

The officially recommended font is [`Inter`](https://fonts.google.com/specimen/Inter). To ensure optimal functionality of the `{cccmthemes}` package, please make sure that the `Inter` font is installed on your device prior to usage.
The officially recommended font is [`Inter`](https://github.com/rsms/inter). To ensure optimal functionality of the `{cccmthemes}` package, please make sure that the `Inter` font is installed on your device prior to usage.

## Acknowledgements

Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,12 @@ ggplot(
theme_cccm()
```

<img src="man/figures/README-base-plot-1.png" width="90%" style="display: block; margin: auto;" />

### Font

The officially recommended font is
[`Inter`](https://fonts.google.com/specimen/Inter). To ensure optimal
[`Inter`](https://github.com/rsms/inter). To ensure optimal
functionality of the `{cccmthemes}` package, please make sure that the
`Inter` font is installed on your device prior to usage.

Expand Down
Binary file added man/figures/README-base-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 19c3913

Please sign in to comment.