mirror of
https://github.com/abocn/TelegramBot.git
synced 2025-04-28 09:15:57 +00:00
docs: linting and convert bullet point to tip
This commit is contained in:
parent
7750b522ab
commit
3f71d0c8ca
20
README.md
20
README.md
@ -1,30 +1,40 @@
|
||||
# Kowalski (Node.js Telegram Bot)
|
||||
|
||||
[](CODE_OF_CONDUCT.md)
|
||||

|
||||
|
||||
Kowalski is a a simple Telegram bot made in Node.js.
|
||||
|
||||
- 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)
|
||||
- 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).
|
||||
|
Loading…
x
Reference in New Issue
Block a user