From 1e1cd79c8a4e6433014a277b97cf00d9eb100fe7 Mon Sep 17 00:00:00 2001
From: Ty Garber <tyler.garber@dfw.wa.gov>
Date: Thu, 2 May 2024 12:14:18 -0700
Subject: [PATCH] readme

---
 R/marine.R |  9 ++++++---
 README.md  | 19 +++++++++++++++++--
 2 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/R/marine.R b/R/marine.R
index ad3f965..aea33f6 100644
--- a/R/marine.R
+++ b/R/marine.R
@@ -36,13 +36,16 @@ marine_pull <- function(catch_area, start_date, end_date, int_dates = FALSE,
     check_freshness()
   }
 
-  query <- pssp_query(query =
-                           glue::glue("select
+  query <- pssp_query(
+    query =
+      glue::glue(
+        "select
               *
              from mvw_dockside_marine
              where
                   survey_datetime between '{start_date}' and '{end_date}' and
-                  catch_area_code in('{catch_area}')")
+                  catch_area_code in('{catch_area}')"
+      )
   )
 
   if (int_dates){
diff --git a/README.md b/README.md
index 5f1713f..1594f5a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,21 @@
+# pssp
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![R-CMD-check](https://github.com/FRAMverse/pssp/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/FRAMverse/pssp/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
-# pssp
-Rewrite of the pssp R Package
+
+
+## Overview
+
+pssp is a package that works with WDFW collected Puget Sound creel sampling data. 
+None of the functions with retrieve data will work outside of the state network,
+although functions focused on analysis will work give the proper dataset.
+
+## Installation
+
+``` r
+devtools::install_github("FRAMverse/pssp")
+
+# Alternatively 
+remotes::install_github("FRAMverse/pssp")
+```