aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2016-07-14 11:57:12 +0000
committerJoris2016-07-14 12:00:05 +0000
commit69e69017b75d1cdaa1fd2aef2818de5111b29735 (patch)
tree99dba8f67dc1c55b2cc22f33f81c59c7355b337b /README.md
parent04f9a66c66ca137d9fee6ccca228c41fec960fe0 (diff)
downloadad-listener-69e69017b75d1cdaa1fd2aef2818de5111b29735.tar.gz
ad-listener-69e69017b75d1cdaa1fd2aef2818de5111b29735.tar.bz2
ad-listener-69e69017b75d1cdaa1fd2aef2818de5111b29735.zip
Update code and fix parsers
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 12 insertions, 25 deletions
diff --git a/README.md b/README.md
index 721f79e..2d17e1c 100644
--- a/README.md
+++ b/README.md
@@ -4,40 +4,27 @@ leboncoin-listener
leboncoin-listener listen for changes at a given URL on the website leboncoin
and send mails with a detail whenever new ads come up.
-Usage
------
+Getting started
+---------------
+
+Install nix:
```
-cabal sandbox init
-cabal install --only-dependencies
-cabal build
-./dist/build/leboncoin-listener/leboncoin-listener
+curl https://nixos.org/nix/install | sh
```
-Configuration
--------------
-
-Provide the url you want to listen to, the mail addresses that will be notified
-in the configuration file (conf), the properties you want to get from the
-detail page:
+Inside the project directory, open a nix shell:
```
-# Lines beginning with '#' are ignored"
-
-# 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
+nix-shell
+```
-# The properties field is an optional list
-# properties = cp, city, surface, ges
+Configuration
+-------------
-# The waitDurationInMinutes field is an optional integer, default to 1
-# waitDurationInMinutes = 60
-```
+See [application.conf](application.conf).
Email
-----
-leboncoin-listener uses the sendmail command for notifications.
+`sendmail` command is used for notifications.