From 58b8bede57f8c6cfe83de8523fba8df8b93b1cdf Mon Sep 17 00:00:00 2001
From: sij-ai <67624670+sij-ai@users.noreply.github.com>
Date: Tue, 7 Jan 2025 22:51:27 -0800
Subject: [PATCH] Update README.md
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 8d01987..aa5b6e6 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# llux
-llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It uses local LLMs via [Ollama]([https://ollama.ai/](https://ollama.com) for chat and image recognition, and offers image generation via [FLUX.1](https://github.com/black-forest-labs/flux). Each user in a Matrix room can set a unique personality (or system prompt), and conversations are kept per user, per channel. Model switching is also supported if you have multiple models installed and configured.
+llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It uses local LLMs via [Ollama](https://ollama.ai/) and supports both image recognition and image generation. Each user in a Matrix room can set a unique personality (or system prompt), and conversations are kept per user, per channel. Model switching (OpenAI or Ollama) is also supported if you have multiple models configured.
## Getting Started
@@ -17,7 +17,8 @@ llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It us
- Create a Matrix account for your bot (on a server of your choice).
- Record the server, username, and password.
- - Add these details, along with any custom models, to your `config.json`.
+ - **Copy `config.yaml-example` to `config.yaml`** (e.g., `cp config.yaml-example config.yaml`).
+ - In your new `config.yaml`, fill in the relevant fields (Matrix server, username, password, channels, admin usernames, etc.). Also configure the Ollama section for your model settings and the Diffusers section for image generation (model, device, steps, etc.).
4. **Run llux**
`python3 llux.py`
@@ -45,9 +46,8 @@ llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It us
### Admin Commands
- **.model modelname**
-
- Omit `modelname` to show the current model and available options.
- - Include `modelname` to switch.
+ - Include `modelname` to switch to that model.
- **.clear**
Reset llux for everyone, clearing all stored conversations and returning to the default settings.