From 5d0e0cdf7d50685c01a5429e6e6e831df61231c1 Mon Sep 17 00:00:00 2001
From: Ryan Greenup <exogenesis@protonmail.com>
Date: Wed, 15 Jul 2020 00:35:14 +1000
Subject: [PATCH] guidelines for Modularity

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 882b46b..947c015 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,17 @@ this is an attempt to wrap them into a single script and then have aliases to ma
 
 ## Philosophy
 
+- SubFunctions will take only two arguments:
+    - `-h` or `--help` as a help function
+        - If this is seen anywhere the help will be printed and the script exit will.
+    - Some type of input: 
+        - `-d` or `--dir` as a directory location
+        - `-p` or `--path` as a file location
+        - `STDIN` which is piped into the subfunction.
+
+
+
+
 -  ****<span style="color:rgb(90,210,90);font-family:Courier New,Courier, monospace,serif;">cadmus</span>**** will take the notes directory from the global variable `CADMUS_NOTES_DIR`
     - The Actual work will be done by subscripts denoted by `description.bash`
         - The subscripts will take the note directory as an argument so they are portable and modular