diff --git a/.Rbuildignore b/.Rbuildignore index e22550d..303860a 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,5 +1,5 @@ ^.*\.Rproj$ ^\.Rproj\.user$ ^\.github$ -README.md +^README.md ^LICENSE\.md$ diff --git a/README.md b/README.md new file mode 100644 index 0000000..b498b8e --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ + +# xmrpeers + + + [![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) + + +`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") +``` +