Skip to content

Commit 7660be5

Browse files
committed
Reword program description
1 parent 32849f8 commit 7660be5

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

.github/workflows/push-docker.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ jobs:
3939
tags: smtp_to_telegram
4040
build-args: |
4141
ST_VERSION=${{ steps.git_version.outputs.ST_VERSION }}
42-
- run: docker run --platform=linux/amd64 --rm smtp_to_telegram --help 2>&1 | grep 'A small program which listens'
43-
- run: docker run --platform=linux/arm/v6 --rm smtp_to_telegram --help 2>&1 | grep 'A small program which listens'
44-
- run: docker run --platform=linux/arm/v7 --rm smtp_to_telegram --help 2>&1 | grep 'A small program which listens'
45-
- run: docker run --platform=linux/arm64 --rm smtp_to_telegram --help 2>&1 | grep 'A small program which listens'
42+
- run: docker run --platform=linux/amd64 --rm smtp_to_telegram --help 2>&1 | grep 'A simple program that listens'
43+
- run: docker run --platform=linux/arm/v6 --rm smtp_to_telegram --help 2>&1 | grep 'A simple program that listens'
44+
- run: docker run --platform=linux/arm/v7 --rm smtp_to_telegram --help 2>&1 | grep 'A simple program that listens'
45+
- run: docker run --platform=linux/arm64 --rm smtp_to_telegram --help 2>&1 | grep 'A simple program that listens'
4646

4747
- uses: docker/login-action@v3
4848
with:

Readme.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@
88
[Go Report Card]: https://goreportcard.com/report/github.com/KostyaEsmukov/smtp_to_telegram
99
[License]: https://github.com/KostyaEsmukov/smtp_to_telegram/blob/master/LICENSE
1010

11-
`smtp_to_telegram` is a small program which listens for SMTP and sends
11+
`smtp_to_telegram` is a simple program that listens for SMTP and forwards
1212
all incoming Email messages to Telegram.
1313

14-
Say you have a software which can send Email notifications via SMTP.
15-
You may use `smtp_to_telegram` as an SMTP server so
14+
Say you have a software that can send Email notifications via SMTP.
15+
You can use `smtp_to_telegram` as an SMTP server so
1616
the notification mail would be sent to the chosen Telegram chats.
1717

1818
## Getting started
1919

2020
1. Create a new Telegram bot: https://core.telegram.org/bots#creating-a-new-bot.
21-
2. Open that bot account in the Telegram account which should receive
21+
2. Open that bot account in the Telegram account that should receive
2222
the messages, press `/start`.
2323
3. Retrieve a chat id with `curl https://api.telegram.org/bot<BOT_TOKEN>/getUpdates`.
24-
4. Repeat steps 2 and 3 for each Telegram account which should receive the messages.
24+
4. Repeat steps 2 and 3 for each Telegram account that should receive the messages.
2525
5. Start a docker container:
2626

2727
```
@@ -33,7 +33,7 @@ docker run \
3333
```
3434

3535
Assuming that your Email-sending software is running in docker as well,
36-
you may use `smtp_to_telegram:2525` as the target SMTP address.
36+
you can use `smtp_to_telegram:2525` as the target SMTP address.
3737
No TLS or authentication is required.
3838

3939
The default Telegram message format is:
@@ -42,7 +42,7 @@ The default Telegram message format is:
4242
From: {from}\\nTo: {to}\\nSubject: {subject}\\n\\n{body}\\n\\n{attachments_details}
4343
```
4444

45-
A custom format might be specified as well:
45+
A custom format can be specified as well:
4646

4747
```
4848
docker run \

smtp_to_telegram.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ func GetHostname() string {
9090
func main() {
9191
app := cli.NewApp()
9292
app.Name = "smtp_to_telegram"
93-
app.Usage = "A small program which listens for SMTP and sends " +
93+
app.Usage = "A simple program that listens for SMTP and forwards " +
9494
"all incoming Email messages to Telegram."
9595
app.Version = Version
9696
app.Action = func(c *cli.Context) error {

0 commit comments

Comments
 (0)