xmrpeers/README.md

# xmrpeers

  <!-- badges: start -->
  [![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
  [![R-CMD-check](https://github.com/Rucknium/xmrpeers/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Rucknium/xmrpeers/actions/workflows/R-CMD-check.yaml)
  <!-- badges: end -->

`xmrpeers` is an alpha project. Expect breaking changes in future versions.

## Installation

Install R. Linux users should install the `r-base` and `r-base-dev` system packages.

You can install the development version of xmrpeers from [GitHub](https://github.com/) if you have `git` and `curl` installed on your system with:

```R
install.packages("remotes")
remotes::install_github("Rucknium/xmrpeers", upgrade = FALSE)
```