aboutsummaryrefslogtreecommitdiffstats
path: root/modules/README.md
diff options
context:
space:
mode:
authorSquibid <me@zacharyscheiman.com>2024-07-27 09:26:54 -0400
committerSquibid <me@zacharyscheiman.com>2024-07-27 09:26:54 -0400
commit16f32bdcdd10c3dc95519b5f0ab4d6818b3a3bfe (patch)
tree6edc384d7e72662dc1e58f0722353ce841f891cc /modules/README.md
parent878f0faaf7f472b96ab5a7f0e4db266111b2d3ce (diff)
downloadeat-it-16f32bdcdd10c3dc95519b5f0ab4d6818b3a3bfe.tar.gz
eat-it-16f32bdcdd10c3dc95519b5f0ab4d6818b3a3bfe.tar.bz2
eat-it-16f32bdcdd10c3dc95519b5f0ab4d6818b3a3bfe.zip
complete refactor see README for more infov3.0
Diffstat (limited to 'modules/README.md')
-rw-r--r--modules/README.md28
1 files changed, 0 insertions, 28 deletions
diff --git a/modules/README.md b/modules/README.md
deleted file mode 100644
index 614a9b2..0000000
--- a/modules/README.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# 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',
-}
-```