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 = "#>"
)
```

# tidynhl <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![R-CMD-check](https://github.com/jplecavalier/tidynhl/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jplecavalier/tidynhl/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## Overview

`tidynhl` is a user-friendly R package which aims at facilitating data extraction through the NHL API in a ready-to-use tidy format.

## Installation

As of now, `tidynhl` is only an experimental package, thus not released on CRAN.

You can install the experimental version of the package directly form github by running the following command :
```{r install, eval=FALSE}
remotes::install_github("jplecavalier/tidynhl")
```