revamp README.md (#8)

README.md

@@ -1,25 +1,26 @@
-# Lotb: Lord of telegram bots
+# Lotb
 
 ![logo](logo.png)
 
-*One bot to rule them all, one bot to find them, one bot to bring them all and in the darkness run them.*
+*One bot to rule them all, one bot to find them, one bot to bring them all and in the darkness run them.* 💍
 
-## Why?
+## Why❓
+<details>
+<summary>
+</summary>
+Several years ago telegram introduced the Bot API, and since then, I have used it to automate tasks and send notifications to my groups.
 
-Several years ago Telegram introduced the Bot api, and since then, I have used it to automate tasks and send notifications
-to my groups.
-
-While the python-telegram-bot library has been my go-to choice, I often found myself reinventing
-the wheel for each bot I created or used from others people projects.
+While the `python-telegram-bot` library has been my go-to choice, I often found myself reinventing the wheel for each bot I created or used from others' projects.
 I also had to update all my bots whenever telegram introduced new features or changed its implementation.
 
 To eliminate this pain and save time, I decided to develop a more dry approach for my bots.
 This system is plugin-based and it shares a common core logic, making it easier to define new bots with just a few lines of code.
+</details>
 
-### Features
+### Features ✨
 
 * Plugins based: you can enable or disable plugins either at runtime or in the config
-* Each plugin have his own config entry and entry in the config can be overridden by the env var (useful for secrets)
+* Each plugin has its own config entry and entry in the config can be overridden by the env var (useful for secrets)
 * Built-in helper methods to:
   * create, register and run bot commands
   * intercept messages based on a regex and run a callback
@@ -29,9 +30,9 @@ This system is plugin-based and it shares a common core logic, making it easier
   * schedule tasks for your plugin using the job queue scheduler
   * support for job queue scheduler so you can schedule tasks for your plugin
   * auth: define a list of users or authorize specific groups to interact with the bot
-* Great test coverage (> 70%)
+* Great test coverage (> 70%) ✅
 
-### How to use it?
+### How to use it? 📦
 
 * Clone this repo (will probably be published on pypi in the future)
 * Install the dependencies with poetry
@@ -51,28 +52,26 @@ poetry install
 poetry run lotb --config config.toml
 ```
 
-### Docker
+### Docker 🐳
 
-You can also run the bot using docker, the registry is `ghcr.io/brokenpip3/lotb`, just create a config file
-and mount it in the container:
+You can also run the bot using docker, the registry is `ghcr.io/brokenpip3/lotb`, just create a config file and mount it in the container:
 
 ```bash
 docker run -v $(pwd)/config.toml:/config.toml ghcr.io/brokenpip3/lotb:0.0.1 --config /config.toml
 ```
 
-or you can also find a docker-compose example in the [docker-compose-example.yml](./docker-compose-example.yml) file.
-
+or you can also find a docker-compose example in the [docker-compose-example.yaml](./docker-compose-example.yaml) file.
 
-## Plugins
+## Plugins 🔌
 
-By default the bot will load all the plugins in the `lotb/plugins` directory.
+By default, the bot will load all the plugins in the `lotb/plugins` directory.
 You can disable a plugin by removing it from the `plugins` list in the config file.
 You can also make the bot load a plugin from a different directory by passing another path
 to the `core.plugins_additional_directory` key in the config file.
 
 ### Available plugins
 
-Be aware that these are the plugins that I wrote for my own use, and they may be or not be useful for you.
+Be aware that these are the plugins that I wrote for my own use, and they may or may not be useful for you.
 
 * [Welcome](./lotb/plugins/welcome.py): Just an example plugin that will reply to a welcome message
 * [RSSfeed](./lotb/plugins/rssfeed.py): A plugin that will fetch a list of rss feeds and send the new entries every X minutes:
@@ -93,7 +92,7 @@ Be aware that these are the plugins that I wrote for my own use, and they may be
   alertmanager_url = "https://my.prometheus.server" # the url of the prometheus server
   alert_interval = 1 # the interval in minutes
   ```
-* [Readwise](./lotb/plugins/readwise.py): A plugin that will add let you add the quoted url in your readwise reader account:
+* [Readwise](./lotb/plugins/readwise.py): A plugin that will let you add the quoted url in your Readwise reader account:
   ```toml
   [plugins.readwise]
   enabled = true # enable or disable the plugin
@@ -104,31 +103,32 @@ Be aware that these are the plugins that I wrote for my own use, and they may be
   [plugins.notes]
   enabled = true # enable or disable the plugin
   ```
-* [Memo](./lotb/plugins/memo.py): A plugin that will let you save memos based on regex or first word and save it in separate files.
-  Per each category the plugin will save the memo in a different file automatically by starting the message with the category name,
+* [Memo](./lotb/plugins/memo.py): A plugin that will let you save memos based on regex or the first word and save it in separate files.
+  For each category, the plugin will save the memo in a different file automatically by starting the message with the category name,
   for instance: `todo: buy milk` will save the memo in the todo file:
   ```toml
   [plugins.memo]
-  generic="path/to/generic/memo" # path to the generic memo file
+  generic = "path/to/generic/memo" # path to the generic memo file
   todo = "path/to/todo" # path to the todo memo file
   book = "" # path to the book memo file
   series = "" # path to the series memo file
   film = "" # path to the film memo file
   ```
-* [Image](./lotb/plugins/images.py): A plugin that will let you save image id in sqlite and call it in a group chat with `imagename.img` or search
-  for images with `/image search term` using unsplash:
+* [Image](./lotb/plugins/images.py): A plugin that will let you save image ids in sqlite and call it in a group chat with `imagename.img` or search
+  for images with `/image search term` using Unsplash:
   ```toml
   [plugins.image]
   accesskey = "your_access_key" # can be also set as env var: LOTB_PLUGINS_IMAGE_ACCESSKEY
   secretkey = "your_secret_key" # can be also set as env var: LOTB_PLUGINS_IMAGE_SECRETKEY
   ```
 
-### How to add a plugin? What helpers methods are available?
+### How to add a plugin? What helper methods are available?
 
-check [CONTRIBUTING.md](./CONTRIBUTING.md)
+Check [CONTRIBUTING.md](./CONTRIBUTING.md)
 
-## Credits
+## Credits 🙏
 
+* Thanks to the [`python-telegra-bot`](https://github.com/python-telegram-bot/python-telegram-bot) dev team for the great library
 * Thanks DALL-E for the great logo
 * This repo has been initialized with: