From d8aaacf868462dcdea59b629a019188962ee45ac Mon Sep 17 00:00:00 2001 From: Mattia Mascarello Date: Thu, 16 May 2024 11:44:17 +0200 Subject: [PATCH] Emojified readme --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 747917f..7433c42 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,42 @@ -# Birthday Reminder Bot -A simple telegram bot that reminds you of your friends' birthdays. +# Birthday Reminder Bot 🎂 +A simple telegram bot 🤖 that reminds you of your friends' birthdays 🥳. -- Birthday list (current age, time to birthday, sorted) -- Monthly, weekly, daily reminders +- Birthday list (current age ⏲️, time to birthday 🔜, sorted 🥇) +- Monthly 📆, weekly 📆, daily 📆 reminders > I made this bot for my personal use, but you can use it too. Just follow the instructions below. -## Installation +## Installation : 1. Clone the repository ```bash git clone git@github.com:MatMasIt/birthdaybot.git ``` -2. Create a virtual environment +2. Create a virtual environment 🏗️ ```bash python3 -m venv venv ``` -3. Activate the virtual environment +3. Activate the virtual environment 🔦 ```bash source venv/bin/activate ``` -4. Install the requirements +4. Install the requirements 📥 ```bash pip install -r requirements.txt ``` -5. Create a `.env` file in the root directory and add the following variables +5. Create a `.env` file in the root directory and add the following variables (you can obtain the token at [@botfather](https://t.me/botfather)) ```bash TOKEN=YOUR_TELEGRAM_BOT_TOKEN ``` -6. Run the bot +6. Run the bot ⏯️ ```bash python bot.py -``` \ No newline at end of file +```