Create readme.md

Bot/Handler/ChatCommand/readme.md

@@ -0,0 +1,8 @@
+## Ollama - Large Language Model Chat - Handler
+
+This handler "owns" the logic for accessing the ollama api, which runs the transformer model.
+
+> How to get started with a local chat bot see: [Run LLMs Locally using Ollama](https://marccodess.medium.com/run-llms-locally-using-ollama-8f04dd9b14f9)
+
+Assuming you are on the same network as the Ollama server you should configure it to be accessible to other machines on the network, however this is only required if you aren't running it from localhost relative to the bot.
+See: [How do I configure Ollama server?](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server)

Bot/README.md

@@ -2,9 +2,14 @@
 ```mermaid
 flowchart TD
     Program[Program] -->|Register| EventListener
-    EventListener[DiscordEventListener] --> A
+    EventListener[DiscordEventListener] --> A[MessageReceivedHandler]
 
-    A[MessageReceivedHandler] -->|Message| C{Send to correct command by 
+    EventListener[DiscordEventListener] --> A2[SlashCommandReceivedHandler]
+
+    A --> |Message| f{If bot is mentioned}
+    f --> |ChatCommand| v[ChatHandler]
+
+    A2[SlashCommandReceivedHandler] -->|Message| C{Send to correct command by 
             looking at commandName}
 
     C -->|JoinCommand| D[JoinHandler]
@@ -12,9 +17,33 @@ flowchart TD
     C -->|HelloCommand| F[HelloHandler]
     C -->|GoodbyeCommand| G[GoodbyeHandler]
 ```
-
 Program registers an event listener ```DiscordEventListener``` which publish a message :
 
 ```c#
 await Mediator.Publish(new MessageReceivedNotification(arg), _cancellationToken);
 ```
+
+|Name| Description |
+|--|--|
+| SlashCommandReceivedHandler | Handles commands using ``/`` from any Discord Guild/Server. |
+| MessageReceivedHandler| Listens to **all** messages. |
+
+## Handler integrations
+```mermaid
+flowchart TD
+    D[JoinHandler] --> Disc[Discord Api]
+    E[PlayHandler] --> Disc[Discord Api]
+    F[HelloHandler] --> Disc[Discord Api]
+    G[GoodbyeHandler] --> Disc[Discord Api]
+    v[ChatHandler] --> Disc[Discord Api]
+    v --> o[Ollama Server]
+    o --> v
+    E --> Lava[Lavalink]
+```
+|Name| Description |
+|--|--|
+| JoinHandler| Handles the logic for **just** joining a voice channel. |
+| PlayHandler| Handles the logic for joining and playing music in a voice channel. |
+| HelloHandler| Responds with Hello. (Dummy handler, will be removed)|
+| GoodbyeHandler| Responds with Goodbye. (Dummy handler, will be removed)|
+| ChatHandler| Handles the logic for LLM chat with user. |