Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NikitosKey committed Dec 21, 2024
1 parent 85cfb92 commit af0782c
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,21 @@ Save this token as you will need it to configure your bot in the next steps.
> **Note:** The token is sensitive information and should not be shared publicly.
#### Step 2: Set Up the Bot
First, you need to get repository on your local machine. You can do it by cloning the repository or downloading the zip file.
##### Local Installation Native Method

```shell
# Clone the repository


# Install Git from https://git-scm.com/downloads if you haven't already.
git clone [email protected]:NikitosKey/alcounting_bot.git
cd alcounting_bot
```
And get a token from the `@BotFather` in Telegram.

TODO: Add the instruction how to get the token.

##### Local Installation Native Method

```shell
# Install Python 3.13 if you haven't already.
# Visit https://www.python.org/downloads/ to download the latest version of Python.
# Or use your package manager to install it:
Expand Down Expand Up @@ -93,7 +97,6 @@ source venv/bin/activate
pip install -r requirements.txt

# Create an environment variable BOT_TOKEN and set it to your bot's token.
# You can get the token from @BotFather on Telegram.
export BOT_TOKEN=your_token

# Run the bot
Expand All @@ -114,10 +117,10 @@ That's it!
The bot will now run in the background, processing user requests.
To stop the bot, press `Ctrl+C`.

TODO: Add the Docker installation method instructions.
##### Local Installation Docker Method
##### Local Installation Docker-Compose Method
```shell

# Install Docker and Docker Compose from https://docs.docker.com/get-docker/ and https://docs.docker.com/compose/install/ if you haven't already.
docker-compose up --build
```

> To host the bot remotely instead of running it locally, you'll need to set up a hosting environment.
Expand Down

0 comments on commit af0782c

Please sign in to comment.