From 12660bf1434f031faa39e46a6179ad7a3c59cdd6 Mon Sep 17 00:00:00 2001 From: Micah Wood Date: Wed, 17 Apr 2024 09:06:54 -0400 Subject: [PATCH] Add module responsibilities and critical paths --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 2ae0b73..7ed08cf 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,15 @@ This loader instantiates Newfold WordPress Modules inside our WordPress Plugins. * Understanding the module lifecycle * Module Loader API +## Module Responsibilities +- Provides a dependency injection container for shared dependencies across the brand plugin modules. +- Provides a framework for registering, unregistering, activating, deactivating, and checking if a module is active. +- Provides a plugin class that makes getting basic plugin information simple. + +## Critical Paths +- The dependency injection container should be created by the brand plugin and successfully shared across all other modules. +- Calling the `register()` function should successfully register the module and run the code on the `after_setup_theme` action hook. + ## Newfold WordPress Modules Newfold WordPress modules are PHP packages intended to be installed in WordPress plugins via Composer from our Satis