adds readme

README.md

@@ -0,0 +1,47 @@
+
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# 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.png)](https://CRAN.R-project.org/package=qtkit)
+<!-- badges: end -->
+
+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.
+
+## Getting started
+
+You can install the released version of qtalrkit from
+[CRAN](https://CRAN.R-project.org) with:
+
+``` r
+install.packages("qtkit")
+```
+
+The development version of `qtkit` is on [GitHub](https://github.com/)
+and can be installed with:
+
+``` r
+install.packages("remotes")
+remotes::install_github("qtalr/qtkit")
+```
+
+Then load the package with:
+
+``` r
+library(qtkit)
+```
+
+Please consult the [package
+documentation](https://qtalr.github.io/qtkit/reference) for more
+information.