mirror of
https://github.com/csd4ni3l/meow-bot.git
synced 2026-01-01 04:23:49 +01:00
Add environment file, dont use slackcli run but direct token run instead. Switch to uv for better performance and compatibility, make meow-translator a better catify, add openrouter/LLM support when typing in DMs with a cute cat prompt, fix mrkdown argument, move constants to constants.py, update welcome message, improve README
This commit is contained in:
22
README.md
22
README.md
@@ -1,10 +1,24 @@
|
||||
Cat themed Slack bot which has cute cats and random stuff no one actually needs (also quacking ducks)!
|
||||
|
||||
Features:
|
||||
## Features
|
||||
- Saves humanity
|
||||
- Meow button (if you press it it will reply with a random cat-like word in a thread)
|
||||
- Meow translation (for every word you get a random cat-like word instead)
|
||||
- Catifier which turns all your text to cute cat-like lang.
|
||||
- Cat pictures and reactions when you say meow or any cat-like word and duck pictures/reactions when you say quack/duck-like words!
|
||||
- https://http.cat command which returns the image for the status code, and also replies to any message containing any valid status code with the cat image!
|
||||
- Welcome message when you mention or DM the bot!
|
||||
- Cat facts
|
||||
- Welcome message when you mention the bot!
|
||||
- Cat facts
|
||||
- Cat-like AI when DMed
|
||||
|
||||
## How to run
|
||||
- Download source code from this repo
|
||||
- Install requirements
|
||||
- Use uv and run `uv sync`
|
||||
OR
|
||||
- Install Python >=3.11
|
||||
- Create a venv with `python3 -m venv .venv`
|
||||
- Activate it: `source .venv/bin/activate`
|
||||
- Install requirements: `pip3 install -r requirements.txt`
|
||||
- Move `.env.example` to `.env` and update the example values inside.
|
||||
- Update `constants.py` if you want to change any default values.
|
||||
- Run with `uv run app.py` or `python3 app.py` depending on the environment
|
||||
Reference in New Issue
Block a user