Update README

1 files changed, 8 insertions, 23 deletions

diff --git a/README.md b/README.md
index 589ac6f..f84a260 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
 
 <!-- badges: end -->
 
-The goal of rcsobczak is to easily provide convenience functions I find
+The goal of csobczak.r is to easily provide convenience functions I find
 useful.
 
 ## Installation
@@ -15,7 +15,6 @@ useful.
 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')
 ```
@@ -25,30 +24,16 @@ 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
-library(rcsobczak)
-## basic example code
+library(csobczak.r)
+X <- matrix(data = rnorm(100), nrow = 10)
+R <- cor(X)
+corplot(R, title = 'Example Correlation Plot')
 ```
 
-What is special about using `README.Rmd` instead of just `README.md`?
-You can include R chunks like so:
+<img src="man/figures/README-example-1.png" alt="" width="100%" />
 
 ``` r
-summary(cars)
-#>      speed           dist       
-#>  Min.   : 4.0   Min.   :  2.00  
-#>  1st Qu.:12.0   1st Qu.: 26.00  
-#>  Median :15.0   Median : 36.00  
-#>  Mean   :15.4   Mean   : 42.98  
-#>  3rd Qu.:19.0   3rd Qu.: 56.00  
-#>  Max.   :25.0   Max.   :120.00
+networkplot(R, title = 'Example Network Plot')
 ```
 
-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:
-
-<img src="man/figures/README-pressure-1.png" alt="" width="100%" />
-
-In that case, don’t forget to commit and push the resulting figure
-files, so they display on GitHub and CRAN.
+<img src="man/figures/README-example-2.png" alt="" width="100%" />