From 37a37f09300e356952821bf7308475231ed81019 Mon Sep 17 00:00:00 2001
From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com>
Date: Mon, 29 Jun 2020 11:17:25 -0500
Subject: [PATCH] adding readme

---
 lib/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 lib/README.md

diff --git a/lib/README.md b/lib/README.md
new file mode 100644
index 00000000..500e2142
--- /dev/null
+++ b/lib/README.md
@@ -0,0 +1,15 @@
+# Super-Linter Library
+
+## Main script
+The file `linter.sh` is the main script that is called for the process and loads all other scripts as functions.
+
+## Functions
+The additional files in the folder are functions to help streamline the main build process and allow for easier maintenance.
+- `possum.sh`
+  - Official mascot of the **Super-Linter**
+- `buildFileList.sh`
+  - Functions to help find files that were modified, or need to be scanned
+- `validation.sh`
+  - Logic to see what linters are enabled
+- `worker.sh`
+  - Calls to the various linters and the test cases for each