From 5f8a3372e988df4fff1f528ed8a547ecaff7b629 Mon Sep 17 00:00:00 2001 From: Maxwell Date: Tue, 11 Jun 2024 19:08:10 +1000 Subject: [PATCH] Add instructions for self hosting --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7646d2..5529b10 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -### Alfreda +## Alfreda Alfreda is the most cursed discord bot ever. @@ -6,4 +6,16 @@ Read more at https://maxwellj.xyz/alfreda Issues and more are avaliable in this repo, and feel free to clone and experiment! -*gpl my beloved* \ No newline at end of file +*gpl my beloved* + +### Setup (for self hosting) + +1. If you're using Linux, or another platform that doesn't allow packages install through Pip, make a virtual environment. `python -m venv path/to/venv` and activate it with `source path/to/venv/bin/activate.fish` (if using fish, use activate while using bash or sh) + +2. Run `pip install anthropic discord` to install the Anthropic and Discord API wrappers. (duh) + +3. Clone the repo `git clone https://git.maxwellj.xyz/max/alfreda.git` and `cd alfreda` + +3. Edit the main.py file with your Anthropic and Discord API keys. Get them at https://console.anthropic.com and https://discord.dev **Be sure to not share these with anyone, as you might allow someone to use your Anthropic credits or send messages through your Discord bot!** + +4. `python3 main.py` \ No newline at end of file