Skip to content

Commit

Permalink
Add markdown notes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
k5cents committed Jul 13, 2024
1 parent f8967cf commit 1f33c09
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 25 deletions.
16 changes: 7 additions & 9 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,14 @@ If a function doesn't work as intended, please file an [issue on GitHub][iss].

## Installation

As of 2024-05-17, fflr was removed from [CRAN][cran] for failure to comply with
the policy on internet resources. This issue arose when ESPN changed their API
format and adjusted andpoints to account for the end of the 2023 NFL season.

> [!IMPORTANT]
> As of 2024-05-17, fflr was removed from [CRAN][cran] for failure to comply
with the policy on internet resources. This issue arose when ESPN changed their
API format and adjusted andpoints to account for the end of the 2023 NFL season.
I hope to work with CRAN to get the package published again before the 2024
season, but it may not be possible.

In the meantime, the most recent development version can always be installed
from [GitHub][gh]:
The most recent development version can always be installed from [GitHub][gh]:

```{r remote, eval=FALSE}
# install.packages("remotes")
Expand Down Expand Up @@ -102,9 +101,8 @@ There are included objects for NFL teams and players.
nfl_teams
```

***

The fflr project is released with a [Contributor Code of Conduct][coc]. By
> [!NOTE]
> The fflr project is released with a [Contributor Code of Conduct][coc]. By
contributing, you agree to abide by its terms.

<!-- refs: start -->
Expand Down
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,16 @@ on GitHub](https://github.com/k5cents/fflr/issues).

## Installation

As of 2024-05-17, fflr was removed from
[CRAN](https://cran.r-project.org/package=fflr) for failure to comply
with the policy on internet resources. This issue arose when ESPN
changed their API format and adjusted andpoints to account for the end
of the 2023 NFL season.
> \[!IMPORTANT\]
> As of 2024-05-17, fflr was removed from
> [CRAN](https://cran.r-project.org/package=fflr) for failure to comply
> with the policy on internet resources. This issue arose when ESPN
> changed their API format and adjusted andpoints to account for the end
> of the 2023 NFL season. I hope to work with CRAN to get the package
> published again before the 2024 season, but it may not be possible.
I hope to work with CRAN to get the package published again before the
2024 season, but it may not be possible.

In the meantime, the most recent development version can always be
installed from [GitHub](https://github.com/k5cents/fflr):
The most recent development version can always be installed from
[GitHub](https://github.com/k5cents/fflr):

``` r
# install.packages("remotes")
Expand All @@ -48,7 +47,7 @@ remotes::install_github("k5cents/fflr")
``` r
library(fflr)
packageVersion("fflr")
#> [1] '2.3.0.9000'
#> [1] '2.3.0'
```

Data is only available for public leagues. See [this help
Expand Down Expand Up @@ -117,11 +116,10 @@ nfl_teams
#> # ℹ 23 more rows
```

------------------------------------------------------------------------

The fflr project is released with a [Contributor Code of
Conduct](https://k5cents.github.io/fflr/CODE_OF_CONDUCT.html). By
contributing, you agree to abide by its terms.
> \[!NOTE\]
> The fflr project is released with a [Contributor Code of
> Conduct](https://k5cents.github.io/fflr/CODE_OF_CONDUCT.html). By
> contributing, you agree to abide by its terms.
<!-- refs: start -->
<!-- refs: end -->

0 comments on commit 1f33c09

Please sign in to comment.