From d3189790998a07f23379488fcf8f096f6dd4f5fc Mon Sep 17 00:00:00 2001
From: Joseph Manley <j@cloudsumu.com>
Date: Sat, 25 Jul 2020 17:49:44 -0400
Subject: [PATCH] Added ReadMe.md

---
 ReadMe.md  | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 action.yml |  2 +-
 2 files changed, 49 insertions(+), 1 deletion(-)
 create mode 100644 ReadMe.md

diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 0000000..3cbe732
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,48 @@
+![Release Version](https://img.shields.io/github/v/release/josephbmanley/run-gut-tests-action) ![Test Action](https://github.com/josephbmanley/run-gut-tests-action/workflows/Test%20Action/badge.svg)
+
+# Run GUT tests
+This is an action that runs [GUT](https://github.com/bitwes/Gut) tests for Godot to easily automate testing.
+
+## Usage
+
+This action will run [GUT](https://github.com/bitwes/Gut) tests inside of a docker image for your Godot project.
+
+Example:
+
+```yaml
+steps:
+- uses: josephbmanley/run-gut-tests-action@[VERSION]
+  with:
+    directory: client
+```
+
+### Inputs
+
+#### containerImage
+
+    The docker image  where GUT tests are inside of. Defaults to `barichello/godot-ci:latest`
+
+#### directory
+
+    The name directory to run tests within. Defaults to the current directory.
+
+## Configure GUT
+
+This action requires you to configure GUT using the `.gutconfig.json` file which would be located in the root directory of your project.
+
+Here is an example `.gutconfig.json`:
+
+```json
+{
+    "dirs":[
+        "res://tests/"
+    ],
+    "include_subdirs":true,
+    "ignore_pause":true,
+    "log_level":2,
+    "should_exit":true,
+    "should_maximize":false
+}
+```
+
+For more information on the config file, [see the GUT wiki](https://github.com/bitwes/Gut/wiki/Command-Line#config-file).
\ No newline at end of file
diff --git a/action.yml b/action.yml
index f649c7a..ba3df5a 100644
--- a/action.yml
+++ b/action.yml
@@ -7,7 +7,7 @@ inputs:
     default: "barichello/godot-ci:latest"
   directory:
     description: "The name directory to run tests in."
-    required: false
+    defaut: "."
 runs:
   using: "node12"
   main: "dist/index.js"