update README for release 1.2.20.

README.md

@@ -38,6 +38,10 @@ $ docker run --rm -v ./soba-backups:/backups -e GITHUB_TOKEN=<token-here> -e GIT
 
 ## latest updates
 
+### 1.2.20 release 2024-10-08
+
+- Add Telegram notifications
+
 ### 1.2.19 release 2024-09-02
 
 - Let user define the request timeout
@@ -155,30 +159,46 @@ note:
 ## rotating backups
 
 A new bundle is created every time a change is detected in the repository. To keep only the _x_ most recent, use the
-following provider specific environment variables:  
-`GITEA_BACKUPS=x`  
-`GITHUB_BACKUPS=x`  
-`GITLAB_BACKUPS=x`  
-`BITBUCKET_BACKUPS=x`  
+following provider specific environment variables:
+`GITEA_BACKUPS=x`
+`GITHUB_BACKUPS=x`
+`GITLAB_BACKUPS=x`
+`BITBUCKET_BACKUPS=x`
 
 ## setting the request timeout
 
-By default, soba will wait up to five minutes for a response to complete. This could be anything from an API call to discover repositories to a clone of a large repository.  
-If you have a slow connection or very large repositories, you may want to increase this. To do so, set the environment variable `GIT_REQUEST_TIMEOUT` to the number of seconds you wish to wait. For example, to wait up to ten minutes:  
+By default, soba will wait up to five minutes for a response to complete. This could be anything from an API call to discover repositories to a clone of a large repository.
+If you have a slow connection or very large repositories, you may want to increase this. To do so, set the environment variable `GIT_REQUEST_TIMEOUT` to the number of seconds you wish to wait. For example, to wait up to ten minutes:
 ```bash
 export GIT_REQUEST_TIMEOUT=600
 ```
 
 ## notifications
 
+### Telegram
+*(since release 1.2.20)*
+To send a Telegram message on completion, set the environment variables:
+`SOBA_TELEGRAM_BOT_TOKEN` with the bot token
+`SOBA_TELEGRAM_CHAT_ID` with the chat/group id
+To get the bot token:
+- send a message to @BotFather of /newbot
+- submit a name, e.g. soba-notifier
+- submit a username for the bot
+- record bot token
+To get the chat id:
+- add the bot user to the group (get group info and click Add)
+- run command:`curl -s -X POST https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates`
+- record the chat id in the response
+
+
 ### Slack
 *(since release 1.2.16)*
-To send a Slack message on completion, set the environment variables:  
-`SLACK_CHANNEL_ID` with the channel id  
-`SLACK_API_TOKEN` with the token for the Slack app  
-For example:  
-`$ export SLACK_CHANNEL_ID=C12345678`  
-`$ export SLACK_API_TOKEN=xoxb-***********-************-************************`  
+To send a Slack message on completion, set the environment variables:
+`SLACK_CHANNEL_ID` with the channel id
+`SLACK_API_TOKEN` with the token for the Slack app
+For example:
+`$ export SLACK_CHANNEL_ID=C12345678`
+`$ export SLACK_API_TOKEN=xoxb-***********-************-************************`
 
 #### note
 - channel id can be in `About` section at bottom of the channel details
@@ -187,25 +207,25 @@ For example:
 
 ### webhooks
 *(since release 1.2.8)*
-To send a webhook on completion of a run: set the environment variable `SOBA_WEBHOOK_URL` with the url of the endpoint.  
-For example:  
+To send a webhook on completion of a run: set the environment variable `SOBA_WEBHOOK_URL` with the url of the endpoint.
+For example:
 `$ export SOBA_WEBHOOK_URL=https://api.example.com/webhook`
 
 #### webhook payload
-The payload is a JSON document containing details of the backup run.  The default format lists each repository and the success or failure of its backup.  You can see an example [here](examples/webhook.json).  
-For a shorter format, with just stats on the success and failure counts, use the environment variable `SOBA_WEBHOOK_FORMAT`.  
-For example:  
-`$ export SOBA_WEBHOOK_FORMAT=short`  
+The payload is a JSON document containing details of the backup run.  The default format lists each repository and the success or failure of its backup.  You can see an example [here](examples/webhook.json).
+For a shorter format, with just stats on the success and failure counts, use the environment variable `SOBA_WEBHOOK_FORMAT`.
+For example:
+`$ export SOBA_WEBHOOK_FORMAT=short`
 You can see a sample [here](examples/webhook-short.json).
 *The default format (if not specified) is `long`*
 
 > NOTE: The long format webhook will contain a list of your repos and, if there's an error, may contain other details including URLs. Please keep this in mind when sending to endpoints that may be insecure.
 
 ### ntfy
 *(since release 1.2.10)*
-ntfy is a popular service that enables push notifications for desktop and mobile apps.  
-To send a message on completion of a run: set the environment variable `SOBA_NTFY_URL` with the url of the endpoint.  
-For example:  
+ntfy is a popular service that enables push notifications for desktop and mobile apps.
+To send a message on completion of a run: set the environment variable `SOBA_NTFY_URL` with the url of the endpoint.
+For example:
 `$ export SOBA_NTFY_URL=https://ntfy.sh/example-topic`
 
 ## logging
@@ -217,16 +237,16 @@ Messages are written to stdout and can be persisted by directing to a file, e.g.
 
 #### logging to /var/log/soba
 
-create a user called soba:  
-`sudo adduser soba`  
-create a log directory:  
-`sudo mkdir /var/log/soba`  
-set user permissions:  
-`sudo chown soba /var/log/soba && sudo chmod 700 /var/log/soba`  
-switch to soba user:  
-`sudo su - soba`  
-run soba and direct output:  
-`soba > /var/log/soba/soba.log`  
+create a user called soba:
+`sudo adduser soba`
+create a log directory:
+`sudo mkdir /var/log/soba`
+set user permissions:
+`sudo chown soba /var/log/soba && sudo chmod 700 /var/log/soba`
+switch to soba user:
+`sudo su - soba`
+run soba and direct output:
+`soba > /var/log/soba/soba.log`
 
 ### rotation