From 9034a3480429220b9fd4d583c2ec3f8d8e62b8ad Mon Sep 17 00:00:00 2001
From: Scott Chamberlain <sachamber@fredhutch.org>
Date: Wed, 1 Nov 2023 12:54:31 -0700
Subject: [PATCH] add README.Rmd so we can build .md from source

---
 README.Rmd | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 README.md  |  3 ++-
 2 files changed, 50 insertions(+), 1 deletion(-)
 create mode 100644 README.Rmd

diff --git a/README.Rmd b/README.Rmd
new file mode 100644
index 0000000..2b0e166
--- /dev/null
+++ b/README.Rmd
@@ -0,0 +1,48 @@
+# sixtyfour
+
+<!-- badges: start -->
+[![Project Status: Concept – Not useable, no support, not open to feedback, unstable API.](https://getwilds.github.io/badges/badges/concept.svg)](https://getwilds.github.io/badges/#concept)
+[![R-CMD-check](https://github.com/getwilds/sixtyfour/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/getwilds/sixtyfour/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+A science-focused, more humane R interface to AWS.
+
+## Installation
+
+Development version
+
+```{r eval=FALSE}
+# install.packages("pak")
+pak::pkg_install("getwilds/sixtyfour")
+```
+
+This package is not on CRAN (yet)
+
+## sixtyfour high level organization
+
+- `aws_billing`: get AWS billing details
+- `aws_bucket*`: manage S3 buckets
+- `aws_file_*`: manage files in S3 buckets on AWS
+- `aws_user*`: manage users on AWS
+- `aws_db*`: interact with AWS databases
+
+
+## Getting Started
+
+You'll need two AWS secrets and the an AWS region:
+
+```
+Sys.setenv(
+  AWS_ACCESS_KEY_ID = "",
+  AWS_SECRET_ACCESS_KEY = "",
+  AWS_REGION = "us-west-2"
+)
+```
+
+## Setting the interface
+
+The function `sixtyfour::set_s3_interface` makes it easier to toggle between S3 compatible backends; right now only supporting AWS S3 itself and [Minio](https://min.io/).
+
+## Code of Conduct
+
+  Please note that the sixtyfour project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
diff --git a/README.md b/README.md
index f00722b..10ca7ae 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,8 @@ A science-focused, more humane R interface to AWS.
 
 Development version
 
-``` r
+
+```r
 # install.packages("pak")
 pak::pkg_install("getwilds/sixtyfour")
 ```