From d619b495a499c378c45a39992ef87423951c8325 Mon Sep 17 00:00:00 2001
From: powermaker450 <support@povario.com>
Date: Thu, 20 Jun 2024 17:02:27 -0400
Subject: [PATCH] Update README.md

---
 README.md | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 8cdf3fe..190a1bc 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,25 @@
 
 ---
 
-## Prerequisites
+# Prerequisites
 - A [Tailchat](https://tailchat.msgbyte.com/docs/deployment/docker-compose) server (duh)
     - Make sure the "Openapi Platform Plugin" and "App Integration" plugins are enabled
 - An OpenAI API Key / OpenAI API compatible service ([LocalAI is recommended](https://localai.io/basics/getting_started/))
     - If you are using something like LocalAI, be sure to have a decently powerful machine to make response times as fast as possible!
 
-## Getting started
+## Included
+- A sensible system prompt
+- Automatically detect and analyze images
+- Generate images with the prefix "Please generate:"
+
+## Not inlcuded
+- Any LLM, API endpoint, API keys or anything similar
+- Filtering or moderation
+- Extensive testing of the system prompt, so no rigorous testing of declining dangerous/illegal requests users may present 
+
+---
+
+# Getting started
 1. Clone the project and install dependencies:
 ```bash
 git clone https://git.povario.com/powermaker450/Tailchat-Assistant && cd Tailchat-Assistant
@@ -65,4 +77,12 @@ SAFE_WORD=\
 SELF= 
 # The user ID of your bot which you can get from the admin panel or database.
 # THIS IS NEEDED SO THAT THE BOT DOES NOT RESPOND TO IT'S OWN MESSAGES.
-# BE SURE TO FILL THIS IN.
\ No newline at end of file
+# BE SURE TO FILL THIS IN.
+```
+
+5. After completing these steps and making any desired changes, build and run the project:
+```bash
+npm run build
+
+npm run start
+```
\ No newline at end of file