Skip to content

Commit 3d55de7

Browse files
committed
update readme
1 parent a2bd3df commit 3d55de7

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22
# gomail
33

44
One day my friend asked me if it's possible to automate sending e-mails, so I
5-
decided it's a great opportunity to practise Go and here it is - a tiny program
5+
decided it's a great opportunity to practice Go and here it is - a tiny program
66
that can send e-mails via SMTP.
77

88
**It was created for educational purposes only, don't use it to spread spam.**
99

10+
**You need to have an account on a mail server (e. g. Gmail, Outlook or own
11+
server) to use this program!**
12+
1013
## How to install
1114

1215
### Stable release
@@ -19,7 +22,7 @@ https://github.com/alexcoder04/gomail/releases/latest.
1922
```sh
2023
git clone https://github.com/alexcoder04/gomail
2124
cd gomail
22-
make linux # or make windows
25+
make linux # or `make windows`
2326
```
2427

2528
## How to use (important!)
@@ -30,32 +33,38 @@ executable is run in. Those are:
3033

3134
### `settings.yml`
3235

36+
You can use another file by passing the `-s` flag (e. g. `gomail -s mysettings.txt`)
37+
3338
The host address can vary depending on your e-mail provider, most likely it's
34-
something like *mail.domain.tld* or *smtp.domain.tld*. The port also is
39+
something like *mail.domain.tld* or *smtp.domain.tld*. The port is also
3540
different for different e-mail providers.
3641

3742
For my provider, the username is the part of the address before the @-sign,
38-
but it may be the full address or something completely different for your
39-
e-mail provider.
43+
but it may be the full address (e. g. on Gmail) or something completely
44+
different for your e-mail provider.
4045

4146
```yml
4247
4348
Addr: smtp.example.com:587
4449
Host: smtp.example.com
45-
Subject: Hello friends!
4650
4751
Password: YourSecureP4ssw0rd
52+
Subject: Hello friends!
4853
```
4954
5055
### `recipients.txt`
5156

57+
You can use another file by passing the `-r` flag (e. g. `gomail -r friendslist.txt`)
58+
5259
```text
5360
5461
5562
```
5663

5764
### `mail.txt`
5865

66+
You can use another file by passing the `-b` flag (e. g. `gomail -b hello.txt`)
67+
5968
```text
6069
Hello friends,
6170

0 commit comments

Comments
 (0)