From dd1e11bd4515be9fabbc37abf5d963ae2342c973 Mon Sep 17 00:00:00 2001 From: Sphericalkat Date: Sat, 25 May 2024 16:37:50 +0530 Subject: [PATCH] feat(readme): add instructions for running Signed-off-by: Sphericalkat --- .github/workflows/build.yaml | 1 - README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 6d9d81a..ac4c32e 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -21,7 +21,6 @@ jobs: permissions: contents: read packages: write - attestations: write id-token: write steps: diff --git a/README.md b/README.md new file mode 100644 index 0000000..88b0b9c --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Deezbot + +A simple telegram bot that uses NLP to decide which messages to reply to with ` deez`. + +## Getting started + +There's a few ways to get the bot up and running. The easiest way is to use the docker image provided in the repository. If you want to run the bot locally, you can follow the [instructions](#local-setup). + +### Docker +A docker image is provided in the repository. To run the bot using docker, follow the steps below: +``` +docker run -e BOT_TOKEN= ghcr.io/sphericalkat/deezbot:main +``` + +### Local setup + +1. Clone the repository +2. Install the requirements + +``` +pip install -r requirements.txt +``` + +3. Create a `.env` file with the following content: + +``` +BOT_TOKEN= +``` + +A sample `.env` file is provided in the repository. 4. Run the bot + +``` +python3 bot.py +```