From 146916ee28358db6b2c68736700be95a835f7ae8 Mon Sep 17 00:00:00 2001
From: terminaldweller <devi@terminaldweller.com>
Date: Sat, 27 Jan 2024 17:13:29 -0500
Subject: added syntax hilighting fo markdown responses

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ff7e552..e477a47 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # milla
 
+Milla is an IRC bot that sends things over to ollama when you ask her questions.
+
+### Config
+
 config:
 
 ```
@@ -7,6 +11,48 @@ ircServer = "myaswesomeircserver.com"
 ircPort = 6697
 ircNick = "milla"
 ircSaslUser = "milla"
-ircSaslPass = "myawesomepassword"
-ircChannel = "#myawesomchannel"
+ircSaslPass = "myaswesomepassword"
+ircChannel = "#myaswesomechannel"
+ollamaEndpoint = "http://172.17.0.1:11434/api/generate"
+ollamaTemp = 0.2
+ollamaSystem = ""
+requestTimeout = 10
+millaReconnectDelay = 60
+enableSasl = true
+model = "llama2-uncensored"
+```
+
+### Deploy
+
+You can use the provided compose file:<br/>
+
+```yaml
+version: "3.9"
+services:
+  milla:
+    image: milla
+    build:
+      context: .
+    deploy:
+      resources:
+        limits:
+          memory: 64M
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "100m"
+    networks:
+      - millanet
+    restart: unless-stopped
+    volumes:
+      - ./config.toml:/opt/milla/config.toml
+    cap_drop:
+      - ALL
+    dns:
+      - 9.9.9.9
+    environment:
+      - SERVER_DEPLOYMENT_TYPE=deployment
+    entrypoint: ["/milla/milla"]
+networks:
+  millanet:
 ```
-- 
cgit v1.2.3