Update to OWD Client v2.0.0-beta.2

README.md

@@ -1,5 +1,9 @@
 # Matrix Rain for OWD Client
-> The famous falling green code in a window, made with p5.js
+> The OWD module to enter the Matrix, made with p5.js
+
+<p>
+    <img src="media/demo.png" alt="OWD Matrix Rain module demo" />
+</p>
 
 <p>
     <a href="https://github.com/MatiTea/owd-matrix-rain/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" /></a>
@@ -10,16 +14,41 @@
 ## Features
 - Display a Matrix Digital Rain in your OWD client
 - Set the speed of the rain
-- Choose the hue of the streams according to your mood
+- Drag horizontally to set the hue of the streams according to your mood
 
 ## Quick install
-- Copy the content of the `client` module folder into `owd-client/src/modules/matrix-rain`
-- Copy the content of the `client/config` config folder into `owd-client/config`
-- Install each module dependency manually with `npm install <dependency>`
-- Add the reference of this module into `owd-client/config/modules.json`
+- Move to your client folder, then
+  ```
+  # Enter modules app directory
+  cd src/modules/app/
+  
+  # Clone this repository
+  git clone https://github.com/MatiTea/owd-app-matrix-rain matrix-rain
+  
+  # Install dependencies using Yarn, or Npm
+  yarn add p5
+  npm install p5
+  ```
+- Define this module in `owd-client/client.extensions.ts`
+  ```js
+  import AboutModule from "@owd-client/core/src/modules/app/about";
+  import DebugModule from "@owd-client/core/src/modules/app/debug";
+  import MatrixRain from "~/modules/app/matrix-rain/client";
+
+  export default {
+    app: {
+      modules: [
+        AboutModule,
+        DebugModule,
+        MatrixRain,
+      ]
+    },
+    ...
+  ```
+- Copy the content of the [client/config](https://github.com/MatiTea/owd-app-matrix-rain/tree/master/client/config) folder into `owd-client/config`
 
 ## Configuration
-Edit the `config/matrix-rain/config.json` file that you copied during the installation
+Edit the `config/matrix-rain/config.json` file
 - #### Set the rain speed
     Choose a number to increase or decrease the speed multiplier
 - #### Set the default streams hue
@@ -31,7 +60,7 @@ Edit the `config/matrix-rain/config.json` file that you copied during the instal
 - p5
 
 ## Compatibility
-- Open Web Desktop client v2.0.0-alpha.5
+- Open Web Desktop client v2.0.0-beta.2
 
 ## License
-This project is released under the [MIT License](LICENSE)
+This project is released under the [MIT License](LICENSE)