diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 12 insertions, 25 deletions
@@ -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. |