README.Rmd

---
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%"
)
```

# acroname

<!-- badges: start -->
<!-- badges: end -->

The goal of acroname is to ...

## Installation

You can install the released version of `acroname` from [GitHub](github.com) with:

``` r
devtools::install_packages_github("acroname")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(acroname)
acroname(required = 
           list('Harvard', 
                c('Automated', 'Algorithmic'), 
                'Redistricting', 
                c('Team', 'Project', 'Group')), 
         optional = list('Methodology')
         )
```