Update Eldritch documentation to include all modules in module list (#…

…495) * Update dev-guide eldritch.md Updated module section to include all modules * Update user-guide eldritch.md --------- Co-authored-by: Hulto <[email protected]>
spellshift · Jan 23, 2024 · 2193142 · 2193142
1 parent a4e8bf3
commit 2193142
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/docs/_docs/dev-guide/eldritch.md b/docs/_docs/dev-guide/eldritch.md
@@ -32,11 +32,14 @@ Want to contribute to Eldritch but aren't sure what to build check our ["good fi
 `docs/_docs/user-guide/eldritch.md`
 Add your function to the docs. Give your function a unique and descriptive name. Assign it to an Eldritch module.
 
-Currently Eldritch has four modules your function can fall under:
+Currently Eldritch has seven modules your function can fall under:
+* `assets`: Is used to interact with files stored natively in the agent.
+* `crypto` Is used to encrypt/decrypt or hash data.
 * `file`: Is used for any on disk file processing.
 * `pivot`: Is used to migrate to identify, and migrate between systems. The pivot module is also responsible for facilitating connectivity within an environment.
 * `process`: Is used to manage running processes on a system.
 * `sys`: Is used to check system specific configurations and start new processes.
+* `time`: Is used for obtaining and formatting time or adding delays into code
 
 If your function does not fall under a specific module reach out to the core developers about adding a new module or finding the right fit.
 

diff --git a/docs/_docs/user-guide/eldritch.md b/docs/_docs/user-guide/eldritch.md
@@ -81,16 +81,18 @@ write_systemd_service()
 
 The standard library is the default functionality that eldritch provides.
 
-It currently contains five modules:
+It currently contains seven modules:
 
 - `assets` - Used to interact with files stored natively in the agent.
+- `crypto` - Used to encrypt/decrypt or hash data.
 - `file` - Used to interact with files on the system.
 - `pivot` - Used to identify and move between systems.
 - `process` - Used to interact with processes on the system.
 - `sys` - General system capabilities can include loading libraries, or information about the current context.
-- `crypto` - Used to encrypt/decrypt or hash data.
+- `time` - General functions for obtaining and formatting time, also add delays into code.
+
 
-Functions fall into one of these five modules. This is done to improve clarity about function use.
+Functions fall into one of these seven modules. This is done to improve clarity about function use.
 
 **🚨 DANGER 🚨: Name shadowing**