From 6acd0e7f095e92f8f4b03652c30668b838a2d7dc Mon Sep 17 00:00:00 2001 From: nightnoryu Date: Sat, 26 Apr 2025 11:34:10 +0300 Subject: [PATCH] Some fixes in README --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d8eac5b..bcd04ce 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,9 @@ Telegram bot for anonymous messages 🎭✨ Prerequisites: -1. git -2. docker +1. Linux +2. Git +3. Docker Firstly, clone the repository: @@ -21,7 +22,7 @@ Then build the binary: ./bin/a3abrewkit build ``` -This script will download a [brewkit](https://github.com/ispringtech/brewkit) binary and put it in the `bin` directory of the project. +This script will download a [brewkit build system](https://github.com/ispringtech/brewkit) binary and put it in the `bin` directory of the project. After that, copy the `docker-compose.override.example.yml` to `docker-compose.override.yml` and set the environment variables: @@ -33,20 +34,15 @@ services: OWNER_CHAT_ID: 123 # ID of your chat with your bot ``` -And you're set! Lastly, run the app: +And you're set! Use the provided `docker-compose` wrapper script to manage the application: ```shell +# Start ./bin/a3acompose up -d -``` -While making changes to the app, don't forget to restart the container: - -```shell +# Restart to apply changes docker restart anon3anon -``` -When you're finished working on the project, bring it down using this command: - -```shell +# Stop ./bin/a3acompose down ```