From 746e44942f42b3409bc31b981442393b08c21363 Mon Sep 17 00:00:00 2001
From: thisfro <jannis@thisfro.ch>
Date: Fri, 29 Sep 2023 20:21:09 +0200
Subject: [PATCH] Update readme

---
 README.md | 35 ++++++++++++++++++++++++++++-------
 1 file changed, 28 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index f101fb3..d5d4039 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,27 @@
 
 Easily send mails via SMTP and python
 
-## Setup
-1. Copy `vars.py.example` to `vars.py`
-2. Setup `vars.py` with your credentials and config
-3. Adapt `message.htmt` and save your contact list to `contacts.csv`
+## Installation
+To install the requirements, run the following command
+```
+python -m pip install -r requirements.txt
+```
 
 ## Usage
-```python mail.py```
+
+### Setup
+1. Copy `vars.py.example` to `vars.py`
+2. Setup `vars.py` with your credentials and config
+3. Adapt `message.html` and save your contact list to `contacts.csv`
+
+### Send mail
+Just run
+```sh
+python mail.py
+```
 
 ## Templating
-You can use the keys from your `csv` directly, prepending a `$` sign. For example:
+You can use the keys from your `csv` directly, prepending a `$` sign (case sensitive!). For example:
 ```
 Hello $name, your value is $value!
 ```
@@ -23,4 +34,14 @@ Hello h4xx0r, your value is 1337!
 With a `contacts.csv` looking like:
 | name   | value |
 |--------|-------|
-| h4xx0r | 1337  |
\ No newline at end of file
+| h4xx0r | 1337  |
+
+## Options
+### Sending behavior
+Some mail servers will block the requests, if too many are sent too fast. You can use the variables to add delays:
+- `WAIT_EVERY` the amount of mails sent at once
+- `DELAY_SEC` the amount of seconds to wait between sending the next batch
+
+### Other options
+- `LOGLEVEL` the logging level, set to `'DEBUG'` for most output
+- `DRY_RUN` if set to `True`, the mails wont get sent, but the output is generated as if they would be sent. Good for testing and best to use with `LOGLEVEL = 'DEBUG'`
\ No newline at end of file