readme.Rmd

.Rbuildignore

@@ -11,3 +11,4 @@
 ^CODE_OF_CONDUCT\.md$
 ^_pkgdown\.yml$
 ^pkgdown$
+^README\.Rmd$

README.Rmd

@@ -0,0 +1,63 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# argonDash <img src="http://www.rinterface.com/inst/images/argonDash.svg" width=200 align="right" />
+
+[![R build status](https://github.com/RinteRface/argonDash/workflows/R-CMD-check/badge.svg)](https://github.com/RinteRface/argonDash/actions)
+[![CRAN status](https://www.r-pkg.org/badges/version/argonDash)](https://cran.r-project.org/package=argonDash)
+[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-ff69b4.svg)](https://www.tidyverse.org/lifecycle/#maturing)
+[![cranlogs](https://cranlogs.r-pkg.org/badges/argonDash)](https://cran.r-project.org/package=argonDash)
+[![total](https://cranlogs.r-pkg.org/badges/grand-total/argonDash)](https://www.rpackages.io/package/argonDash)
+
+> argon Bootstrap4 dashboard template for Shiny
+
+## Installation
+
+`{argonDash}` requires to install `{argonR}`.
+
+```r
+install.packages("argonR")
+# devel version
+devtools::install_github("RinteRface/argonDash")
+# from CRAN
+install.packages("argonDash")
+```
+
+## Demo
+
+```r
+library(argonDash)
+argonDashGallery()
+```
+
+### Vertical layout
+<br>
+<img src="man/figures/argonDashDemo.png">
+
+### Horizontal layout
+
+This layout is experimental.
+
+<br>
+<img src="man/figures/argonDashDemo_horizontal.png">
+
+## Aknowledgement
+
+* [Creative Tim](https://www.creative-tim.com/) for designing the original argon dashboard HTML template.
+
+## Code of Conduct
+
+  Please note that the argonDash project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
+

README.md

@@ -1,7 +1,12 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
 # argonDash <img src="http://www.rinterface.com/inst/images/argonDash.svg" width=200 align="right" />
 
-[![R build status](https://github.com/RinteRface/argonDash/workflows/R-CMD-check/badge.svg)](https://github.com/RinteRface/argonDash/actions)
-[![CRAN status](https://www.r-pkg.org/badges/version/argonDash)](https://cran.r-project.org/package=argonDash)
+[![R build
+status](https://github.com/RinteRface/argonDash/workflows/R-CMD-check/badge.svg)](https://github.com/RinteRface/argonDash/actions)
+[![CRAN
+status](https://www.r-pkg.org/badges/version/argonDash)](https://cran.r-project.org/package=argonDash)
 [![lifecycle](https://img.shields.io/badge/lifecycle-maturing-ff69b4.svg)](https://www.tidyverse.org/lifecycle/#maturing)
 [![cranlogs](https://cranlogs.r-pkg.org/badges/argonDash)](https://cran.r-project.org/package=argonDash)
 [![total](https://cranlogs.r-pkg.org/badges/grand-total/argonDash)](https://www.rpackages.io/package/argonDash)
@@ -12,7 +17,7 @@
 
 `{argonDash}` requires to install `{argonR}`.
 
-```r
+``` r
 install.packages("argonR")
 # devel version
 devtools::install_github("RinteRface/argonDash")
@@ -22,26 +27,29 @@ install.packages("argonDash")
 
 ## Demo
 
-```r
+``` r
 library(argonDash)
 argonDashGallery()
 ```
 
 ### Vertical layout
-<br>
-<img src="man/figures/argonDashDemo.png">
+
+<br> <img src="man/figures/argonDashDemo.png">
 
 ### Horizontal layout
 
 This layout is experimental.
 
-<br>
-<img src="man/figures/argonDashDemo_horizontal.png">
+<br> <img src="man/figures/argonDashDemo_horizontal.png">
 
 ## Aknowledgement
 
-* [Creative Tim](https://www.creative-tim.com/) for designing the original argon dashboard HTML template.
+- [Creative Tim](https://www.creative-tim.com/) for designing the
+  original argon dashboard HTML template.
 
 ## Code of Conduct
-
-  Please note that the argonDash project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
+
+Please note that the argonDash project is released with a [Contributor
+Code of
+Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
+By contributing to this project, you agree to abide by its terms.