From a1fa8e98c255d3b8ea9464cfd63ab76696714691 Mon Sep 17 00:00:00 2001 From: Nikhil Nawgiri Date: Sun, 25 Aug 2024 03:58:37 +0200 Subject: [PATCH] Add README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a503c65 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# matrix-bot-openai-wrapper +## What does this bot do? +This bot relays the prompt to the openai API and sends the answer back to the user who made the request. All this is done through the Matrix chat-client. + +This way they can do less user-tracking if multiple people prompt through the same API token. +Also chat clients, such as Matrix, are more practical to interact with bots. + +## Requirements +* Local environment requires `nodejs`, `yarn` and `nvm` +* Access token for the Matrix account. The access token can be obtained by using this [script](https://git.pub.solar/realestninja/fetch-matrix-access-token). + +## Installation, setup and running the bot +* `yarn install` +* `nvm use` +* `cp config.ts.example config.ts` +* Edit the `config.ts` +* Run `yarn start` to start the bot + +## Planned features +* Improve formatting +* Add logic for user management +* Add option to temporarily set context +* Add option to reset context