Update README

1 files changed, 6 insertions, 20 deletions

diff --git a/README.Rmd b/README.Rmd
index ae300de..b383602 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -18,14 +18,13 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 <!-- badges: end -->
 
-The goal of rcsobczak is to easily provide convenience functions I find useful.
+The goal of csobczak.r 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/csobczak.r')
 ```
@@ -35,22 +34,9 @@ pak::pkg_install('git::https://codeberg.org/csobczak/csobczak.r')
 This is a basic example which shows you how to solve a common problem:
 
 ```{r example}
-library(rcsobczak)
-## basic example code
+library(csobczak.r)
+X <- matrix(data = rnorm(100), nrow = 10)
+R <- cor(X)
+corplot(R, title = 'Example Correlation Plot')
+networkplot(R, title = 'Example Network Plot')
 ```
-
-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.