From da8eb5c3381379f6e405c3ebe14d9a883c52f41a Mon Sep 17 00:00:00 2001
From: Jon Lockwood <jonathon.lockwood@networkedweb.com>
Date: Wed, 11 Aug 2021 12:41:51 +0930
Subject: [PATCH] docs(template): added template readme for CI job folders

#1
---
 .templates/README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 .templates/README.md

diff --git a/.templates/README.md b/.templates/README.md
new file mode 100644
index 0000000..1445d4b
--- /dev/null
+++ b/.templates/README.md
@@ -0,0 +1,40 @@
+# {CI Job Name}
+Summary of job here
+
+This job provides the following badge:
+
+{A badge here}
+
+## Dependencies
+
+- {dependent job name}
+
+## your .gitlab-ci.yml changes
+To use this job add the following to your `.gitlab-ci.yml` file
+
+``` yaml
+variables:
+    VARNAME: "a var value"
+
+stages:
+    - {new stage name}
+
+include:
+    - local: CI/{job name}/.gitlab-ci.yml
+```
+
+## CI/CD Variables required
+
+| var name | Description |
+|:----:|:----|
+| NEW VAR | this var does this and bka |
+
+
+## Job Workflow
+
+
+## Artifacts
+
+
+## License
+To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)