From cec9d2e324a56d8c8132667c50e47f6ca1976729 Mon Sep 17 00:00:00 2001 From: Dillan Date: Tue, 28 Mar 2023 13:45:16 +0200 Subject: [PATCH 1/2] Added installation instructions --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index faaf0e0..3cef8c4 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,10 @@ There are only three useful files in this repository: Note that we use interfaces wherever possible as a matter of principle to maintain decoupling. This abstraction is enforced in DefaultModuleFactory, but it is not necessarily required if you define your own module factory. It's often faster to develop without abstraction. +### Installation + +Using Unity's Package Manager (UPM), select Add New Package from Git URL, and paste the following link: https://github.com/RenderHeads/UnityPlugin-ModulePattern/tree/master/Packages/RH.ModulePattern + ### Example You can use a MonoBehaviour to bootstrap the module system, but there are other ways to bootstrap the module system. You just need a way to create and update the module factory and modules. Using a GameManager/LevelManager's Awake/Start and Update functions suffice most of the time. From ef4b759b9431f1932c1d52f55335dff09bf312da Mon Sep 17 00:00:00 2001 From: Dillan Date: Tue, 28 Mar 2023 13:48:23 +0200 Subject: [PATCH 2/2] Fixed formatting --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3cef8c4..53b0980 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,9 @@ We also provide a factory implementation to access modules program or scene wide - It is **not** a replacement or in competition with DOTS, Jobs, or Burst. You can use them together. - It is **not** a replacement or in competition with MonoBehaviours, MonoBehaviours are still useful for view related logic. +# Installation +Using Unity's Package Manager (UPM), select Add New Package from Git URL, and paste the following URL: https://github.com/RenderHeads/UnityPlugin-ModulePattern/tree/master/Packages/RH.ModulePattern + # Usage There are only three useful files in this repository: - [IModule](https://github.com/RenderHeads/UnityPlugin-ModulePattern/blob/master/Packages/RH.ModulePattern/Runtime/IModule.cs) @@ -55,10 +58,6 @@ There are only three useful files in this repository: Note that we use interfaces wherever possible as a matter of principle to maintain decoupling. This abstraction is enforced in DefaultModuleFactory, but it is not necessarily required if you define your own module factory. It's often faster to develop without abstraction. -### Installation - -Using Unity's Package Manager (UPM), select Add New Package from Git URL, and paste the following link: https://github.com/RenderHeads/UnityPlugin-ModulePattern/tree/master/Packages/RH.ModulePattern - ### Example You can use a MonoBehaviour to bootstrap the module system, but there are other ways to bootstrap the module system. You just need a way to create and update the module factory and modules. Using a GameManager/LevelManager's Awake/Start and Update functions suffice most of the time.