Minor corrections on readme

This commit is contained in:
2021-01-14 23:00:55 +01:00
parent db47089dc5
commit f0efccd539

View File

@@ -2,7 +2,7 @@
This project contains the source code of the Telegram bot [@konatasanbot](https://t.me/konatasanbot). It is the code you need to make her run, although this is only a small part of the actual appliance.
Most importantly, you need a public domain name, a TLS certificate for it and a stable webserver to run this bot. The installer assumes that you do have this webserver already deployed, that your domain is configured and that your webserver is what terminates TLS and reverse proxies incoming requests to the bot. The bot's system should be Alpine, and I recommend using LXC to build it into a container.
Most importantly, you need a public domain name, a TLS certificate for it and a stable webserver to run this bot. The installer assumes that you do have this webserver already deployed (personal website or similar), that your domain is configured and that your webserver is what terminates TLS and reverse proxies incoming requests to the bot. The bot's system should be Alpine, and I recommend using LXC to build it into a container.
While this sounds complicated, it's not really all that difficult to do. I will not document this however and you should look it up if you don't have these already. Which brings me to the allowed usages for this bot's source code.
@@ -20,6 +20,6 @@ Currently this bot is not asynchronous. A command comes in, the bot executes it,
#### Contributing
I hope you'll like using this bot, and learn about the various ways you can run one. If you have any features you'd like to see, feel free to open a pull request along with code against [this repo](https://git.ghnou.su/ghnou/konata/issues). Please make sure to follow the existing coding standards (i.e. case statement, functions, tab indentation etc) when contributing your own.
I hope you'll like using this bot, and learn about the various ways you can run one. If you have any features you'd like to see, feel free to open a pull request along with code against [this repo](https://git.ghnou.su/ghnou/konata). Please make sure to follow the existing coding standards (i.e. case statement, functions, tab indentation etc) when contributing your own.
Enjoy!