add modules directory and lssi, the first module!

1 files changed, 28 insertions, 0 deletions

diff --git a/modules/README.md b/modules/README.md
new file mode 100644
index 0000000..614a9b2
--- /dev/null
+++ b/modules/README.md
@@ -0,0 +1,28 @@
+# Modules
+Modules are extentions to the EatIt plugin manager that aren't necessary for
+running it. Every module will be in it's own sub directory in order to keep 
+documentation relative to the individual modules.
+
+## List of modules
+- `lssi.lua` Lua Script Script Injector for modifing files post install
+
+## Installing
+Installing a module can be done through EatIt like so:
+```lua
+plugins = { -- the plugins you want to load
+  { 'https://git.squi.bid/eat-it',
+    file = 'modules/moddir/module.lua',
+    dir = 'scripts',
+  },
+}
+```
+
+## For Devs
+Please add a table in the global scope called 'mod' as this may be used in the
+future. It should look like this:
+```lua
+mod = {
+  version = 'version',
+  author = 'autor name',
+}
+```