Build README

1 files changed, 56 insertions, 0 deletions

diff --git a/README.Rmd b/README.Rmd
new file mode 100644
index 0000000..7551e05
--- /dev/null
+++ b/README.Rmd
@@ -0,0 +1,56 @@
+---
+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%"
+)
+```
+
+# rcsobczak
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of rcsobczak is to easily provide convenience functions I find useful.
+
+## Installation
+
+You can install the development version of rcsobczak like so:
+
+``` r
+# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
+install.packages('pak')
+pak::pkg_install('git::https://codeberg.org/csobczak/rcsobczak')
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+library(rcsobczak)
+## basic example code
+```
+
+What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
+
+```{r cars}
+summary(cars)
+```
+
+You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
+
+You can also embed plots, for example:
+
+```{r pressure, echo = FALSE}
+plot(pressure)
+```
+
+In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.