From 2530946580b356af867df6c453661861d7d1bb14 Mon Sep 17 00:00:00 2001
From: Brady Holt <brady.holt@gmail.com>
Date: Wed, 25 Jan 2023 12:13:33 -0700
Subject: [PATCH] Add README and LICENSE

---
 LICENSE    | 19 +++++++++++++++++++
 README.md  | 23 +++++++++++++++++++++++
 action.yml |  2 +-
 3 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..6802bc4
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7bfa770
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# US Holiday Action
+
+GitHub Action that determines whether the current system clock date is a US Holiday
+
+## Inputs
+
+### `included_holidays`
+
+**Required** A comma separated list of holiday names to include (from this list: https://github.com/bradymholt/us-holidays-helper/blob/12c6fa7f3e5f64565275a11e39f775177baf2407/src/index.ts#L13-L31)
+
+**Default** `"newYearsDay,martinLutherKingJrDay,presidentsDay,memorialDay,juneteenth,indigenousPeoplesDay,independenceDay,laborDay,thanksgiving,christmas,newYearsEve"`
+
+## Example usage
+
+```yaml
+steps:
+  - uses: ynab/us-holiday-action@1.0
+    id: us-holiday-check
+    with:
+      included_holidays: "newYearsDay,martinLutherKingJrDay,presidentsDay,memorialDay,juneteenth,indigenousPeoplesDay,independenceDay,laborDay,thanksgiving,christmas,newYearsEve"  
+  - run: echo "Today is a US Holiday"
+    if: steps.us-holiday-check.outputs.is-holiday == 'true'
+```
\ No newline at end of file
diff --git a/action.yml b/action.yml
index 460f652..46c4743 100644
--- a/action.yml
+++ b/action.yml
@@ -1,5 +1,5 @@
 name: 'US Holiday Action'
-description: 'GitHub Action that determines if today (system clock) is a US Holiday'
+description: 'GitHub Action that determines whether the current system clock date is a US Holiday'
 inputs:
   included_holidays:
     description: "A comma separated list of holiday names to include (from this list: https://github.com/bradymholt/us-holidays-helper/blob/12c6fa7f3e5f64565275a11e39f775177baf2407/src/index.ts#L13-L31)"