NgTech-LTD/HFCNotificator
2
0
Fork 0
mirror of https://github.com/GaMeNu/HFCNotificator.git synced 2024-11-16 15:24:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

README and /about updates

Browse Source
This commit is contained in:
GaMeNu 2023-10-11 13:01:37 +03:00
parent cc13a110e3
commit 9049f5eaef
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -8,11 +8,13 @@
This is a bot that connects to the HFC's servers and sends real-time notifications about alerts in Israel.
### Setup
Just invite the bot to a server (see "Links" below), and /register a channel to start receiving notifications!
Just invite the bot to a server (see "Links" below), and /register a channel to start receiving notifications!
Please do note that the bot instance listed here is hosted on a private machine, and may be a bit slow (although it doesn't seem to be an issue yet). Feel free to host your own version!
## Self-hosting
### Requirements
#### Required PyPI packages (run with `pip install`)
#### Required PyPI packages (run each with `pip install`)
```
discord.py
mysql-connector-python
@ -31,6 +33,8 @@ DB_USERNAME = <MySQL database username>
DB_PASSWORD = <MySQL database password>
```
note that the .env file must be in the same directory as main.py
## Links
[GitHub](https://github.com/GaMeNu/HFCNotificator)

4
cog_notificator.py
View File

@ -255,7 +255,9 @@ class Notificator(commands.Cog):
value='This is a bot that connects to the HFC\'s servers and sends real-time notifications about alerts in Israel.',
inline=False)
e.add_field(name='Setup',
value='Just invite the bot to a server (see \"Links\" below), and /register a channel to start receiving notifications.',
value='Just invite the bot to a server (see \"Links\" below), and /register a channel to start receiving notifications.\n'
'Please do note that the main version of the bot is hosted on a private machine, so it may be a bit slow (although it doesn\'t seem to be an issue yet).\n'
'Feel free to host your own version!',
inline=False)
e.add_field(name='Can I host it?',
value='Yes! This bot was made with self-hosting in mind.\nMore info on the project\'s README page on GitHub',