diff --git a/README.Rmd b/README.Rmd index f31164a..f4f0711 100644 --- a/README.Rmd +++ b/README.Rmd @@ -13,18 +13,18 @@ knitr::opts_chunk$set( ) ``` -# clemantine +# {clemantine} [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![R-CMD-check](https://github.com/ThinkR-open/clemantine/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/clemantine/actions/workflows/R-CMD-check.yaml) -The goal of clemantine is to help you to build beautiful and efficient Shiny applications. +`{clemantine}` is a package that provides a set of functions around the React component library [Mantine](https://mantine.dev/). ## Installation -You can install the development version of clemantine from [GitHub](https://github.com/) with: +You can install the development version of `{clemantine}` from [GitHub](https://github.com/) with: ```{r, eval=FALSE} # install.packages("devtools") diff --git a/README.md b/README.md index 44c0677..0e8cbec 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# clemantine +# {clemantine} @@ -10,12 +10,12 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h [![R-CMD-check](https://github.com/ThinkR-open/clemantine/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/clemantine/actions/workflows/R-CMD-check.yaml) -The goal of clemantine is to help you to build beautiful and efficient -Shiny applications. +`{clemantine}` is a package that provides a set of functions around the +React component library [Mantine](https://mantine.dev/). ## Installation -You can install the development version of clemantine from +You can install the development version of `{clemantine}` from [GitHub](https://github.com/) with: ``` r diff --git a/man/figures/logo.png b/man/figures/logo.png new file mode 100644 index 0000000..651005d Binary files /dev/null and b/man/figures/logo.png differ