aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index d2ecb93..14458dd 100644
--- a/README.md
+++ b/README.md
@@ -16,9 +16,19 @@ cabal build
Configuration
-------------
-You provide the url you want to listen in a file named conf, for example:
+Provide the url you want to listen to and the mail addresses that will be
+notified in the configuration file:
```
-# This line is a comment
+# The url field is required
url = http://www.leboncoin.fr/locations/offres/ile_de_france/?f=a&th=1
+
+# The mailTo field is an optional list
+# mailTo = jean.dupont@mail.fr, john.smith@mail.com
```
+
+Email
+-----
+
+If you provide mail addresses, leboncoin-listener will try to send mails with
+the sendmail command.