diff --git a/README.md b/README.md index 25ffa5b..1ba7feb 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,40 @@ # Kowalski (Node.js Telegram Bot) + [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) ![GitHub License](https://img.shields.io/github/license/ABOCN/TelegramBot) Kowalski is a a simple Telegram bot made in Node.js. - - You can find Kowalski at [@KowalskiNodeBot](https://t.me/KowalskiNodeBot) on Telegram. + +- You can find Kowalski at [@KowalskiNodeBot](https://t.me/KowalskiNodeBot) on Telegram. ## Self-host requirements - - Node.js 20 or newer (you can also use Bun) - - A Telegram bot (create one at [@BotFather](https://t.me/botfather)) - - Latest version of Node.js - - FFmpeg (only for the /yt command) + +- Node.js 20 or newer (you can also use Bun) +- A Telegram bot (create one at [@BotFather](https://t.me/botfather)) +- Latest version of Node.js +- FFmpeg (only for the `/yt` command) ## Run it yourself, develop or contribute with Kowalski + First, clone the repo with Git: -``` + +```bash git clone https://github.com/ABOCN/TelegramBot ``` + And now, init the submodules with these commands (this is very important): -``` + +```bash cd TelegramBot git submodule update --init --recursive ``` + Next, inside the repository directory, create a `config.env` file with some content, which you can see the [example .env file](config.env.example) to fill info with. To see the meaning of each one, see [the Functions section](#configenv-functions). After editing the file, save all changes and run the bot with ``npm start``. -- To deal with dependencies, just run ``npm install`` or ``npm i`` at any moment to install all of them. + +> [!TIP] +> To deal with dependencies, just run ``npm install`` or ``npm i`` at any moment to install all of them. ## config.env Functions - **botSource**: Put the link to your bot source code. @@ -34,7 +44,9 @@ After editing the file, save all changes and run the bot with ``npm start``. - **weatherKey**: Weather.com API key, used for the `/weather` command. ## Note + - Take care of your ``config.env`` file, as it is so much important and needs to be secret (like your passwords), as anyone can do whatever they want to the bot with this token! ## About/License + BSD-3-Clause - 2024 Lucas Gabriel (lucmsilva).