précise des détails dans le readme
This commit is contained in:
parent
7df57d5f85
commit
6402f98743
13
README.md
13
README.md
|
@ -5,6 +5,7 @@ Simple mailing script.
|
||||||
**Table of content**
|
**Table of content**
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
|
- [Input format](#input_format)
|
||||||
- [Licence](#licence)
|
- [Licence](#licence)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
@ -29,6 +30,18 @@ following packages:
|
||||||
$ ./mailing.py --help
|
$ ./mailing.py --help
|
||||||
$ ./mailing.py -t test-recipients-data -b test-emailling --dry-run --verbose
|
$ ./mailing.py -t test-recipients-data -b test-emailling --dry-run --verbose
|
||||||
|
|
||||||
|
## Input format
|
||||||
|
|
||||||
|
The « to-file » is expected to be csv with the [default
|
||||||
|
dialect](https://docs.python.org/3/library/csv.html?highlight=csv#dialects-and-formatting-parameters)
|
||||||
|
(`delimiter=','`, `char delimiter='"'`).
|
||||||
|
|
||||||
|
The first line is header. The `from` and `to` headers are exepected the be found.
|
||||||
|
|
||||||
|
To avoid boring repetition it is possible to declare a default column value
|
||||||
|
using `:` in header. The default value is considered when the column is lacking,
|
||||||
|
not when the column is empty.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Spamotron is developed by April and licensed under the [GPLv2+](LICENSE).
|
Spamotron is developed by April and licensed under the [GPLv2+](LICENSE).
|
||||||
|
|
Loading…
Reference in New Issue