From 6de601abf8fcd0b96e9b900b6c9d081752561ad8 Mon Sep 17 00:00:00 2001
From: Jerid Francom <francojc@wfu.edu>
Date: Sun, 10 Mar 2024 12:02:50 -0400
Subject: [PATCH] updates README

---
 README.Rmd | 38 ++++++++++++++------------------------
 1 file changed, 14 insertions(+), 24 deletions(-)

diff --git a/README.Rmd b/README.Rmd
index 528486a..4ebf689 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -13,44 +13,34 @@ knitr::opts_chunk$set(
 )
 ```
 
-# qtkit
+# Quantitative Text Kit (`qtkit`)
 
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![CRAN status](https://www.r-pkg.org/badges/version/qtkit)](https://CRAN.R-project.org/package=qtkit)
 <!-- badges: end -->
 
-The goal of qtkit is to ...
+The goal of `qtkit` is to provide a support package for the textbook ["An Introduction to Quantitative Text Analysis for Linguistics: Reproducible Research using R"](https://qtalr.github.io/book). It contains functions for collecting and manipulating data and datasets, documentation, and other assorted tasks associated with quantative text analysis in R.
 
-## Installation
+## Getting started
 
-You can install the development version of qtkit like so:
+You can install the released version of qtalrkit from [CRAN](https://CRAN.R-project.org) with:
 
-``` r
-# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
+```r
+install.packages("qtkit")
 ```
 
-## Example
+The development version of `qtkit` is on [GitHub](https://github.com/) and can be installed with:
 
-This is a basic example which shows you how to solve a common problem:
-
-```{r example}
-library(qtkit)
-## basic example code
+```r
+install.packages("remotes")
+remotes::install_github("qtalr/qtkit")
 ```
 
-What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
-
-```{r cars}
-summary(cars)
-```
+Then load the package with:
 
-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)
+```r
+library(qtkit)
 ```
 
-In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
+Please consult the [package documentation](https://qtalr.github.io/qtkit/reference) for more information.