powermaker450/Tailchat-Assistant
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse source
This commit is contained in:
powermaker450 2024-06-20 17:02:27 -04:00
parent 45f4fd0ab9
commit d619b495a4
1 changed files with 23 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -4,13 +4,25 @@
--- ---
## Prerequisites # Prerequisites
- A [Tailchat](https://tailchat.msgbyte.com/docs/deployment/docker-compose) server (duh) - A [Tailchat](https://tailchat.msgbyte.com/docs/deployment/docker-compose) server (duh)
- Make sure the "Openapi Platform Plugin" and "App Integration" plugins are enabled - 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/)) - 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! - 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: 1. Clone the project and install dependencies:
```bash ```bash
git clone https://git.povario.com/powermaker450/Tailchat-Assistant && cd Tailchat-Assistant git clone https://git.povario.com/powermaker450/Tailchat-Assistant && cd Tailchat-Assistant
@ -65,4 +77,12 @@ SAFE_WORD=\
SELF= SELF=
# The user ID of your bot which you can get from the admin panel or database. # 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. # THIS IS NEEDED SO THAT THE BOT DOES NOT RESPOND TO IT'S OWN MESSAGES.
# BE SURE TO FILL THIS IN. # 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
```