From fae45752dae51d354858942e0971b0b4ba10205b Mon Sep 17 00:00:00 2001
From: Tan-DESKPC <tan@tanho.ca>
Date: Thu, 27 Jan 2022 21:08:56 -0500
Subject: [PATCH] add readme

---
 DESCRIPTION | 6 ++++--
 README.md   | 8 ++++++++
 2 files changed, 12 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/DESCRIPTION b/DESCRIPTION
index d47a250..575df24 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,10 +1,10 @@
 Package: lakehouse
-Title: What the Package Does (One Line, Title Case)
+Title: nflverse data storage
 Version: 0.0.0.9000
 Authors@R: 
     person("Tan", "Ho", , "tan@tanho.ca", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-8388-5155"))
-Description: What the package does (one paragraph).
+Description: This repository holds automated data releases for nflverse projects. 
 License: CC BY 4.0
 Encoding: UTF-8
 LazyData: true
@@ -12,3 +12,5 @@ Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.1.2
 Imports: 
     piggyback
+URL: https://github.com/tanho63/lakehouse
+BugReports: https://github.com/tanho63/lakehouse/issues
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bece5a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# lakehouse
+
+This repository holds automated data releases for nflverse projects. 
+
+## Usage
+
+You can download data hosted here with the `{nflreadr}` package, or manually download and access the [releases](https://github.com/nflverse/lakehouse/releases) page. Releases are roughly organized along the [main functions](https://nflreadr.nflverse.com/reference/) of nflreadr.
+