add readme

DESCRIPTION

@@ -1,14 +1,16 @@
 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
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.1.2
 Imports: 
     piggyback
+URL: https://github.com/tanho63/lakehouse
+BugReports: https://github.com/tanho63/lakehouse/issues

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.
+