Add README.md

This commit is contained in:
Rucknium 2024-04-15 12:23:55 +00:00
parent 0dfd8475d5
commit c357201f5b
2 changed files with 21 additions and 1 deletions

View file

@ -1,5 +1,5 @@
^.*\.Rproj$ ^.*\.Rproj$
^\.Rproj\.user$ ^\.Rproj\.user$
^\.github$ ^\.github$
README.md ^README.md
^LICENSE\.md$ ^LICENSE\.md$

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# 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
You can install the development version of xmrpeers from [GitHub](https://github.com/) with:
```R
# install.packages("devtools")
devtools::install_github("Rucknium/xmrpeers")
```