From 0a4d3c8f12dc5797a919a00b6bcaf759947687cc Mon Sep 17 00:00:00 2001
From: Joris
Date: Sun, 17 Jun 2018 23:24:47 +0200
Subject: Add ouest france parser

---
 README.md | 34 ++++++++++++++++++----------------
 1 file changed, 18 insertions(+), 16 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 41acb3f..53a8e08 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,32 @@
-leboncoin-listener
-==================
+# Ad-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.
+Ad-listener listen for changes at given URLs on
+[leboncoin](https://www.leboncoin.fr/) and
+[ouestFrance](https://www.ouestfrance-immo.com/). Then, it send mails whenever
+new ads come up.
 
-Getting started
----------------
+## Getting started
 
-Install nix:
+1. Install [nix](https://nixos.org/nix/),
+2. launch `make dev-start`,
+3. later, stop the project with `make dev-stop`.
 
-```
-curl https://nixos.org/nix/install | sh
+## Build executable
+
+```bash
+make build
 ```
 
-Inside the project directory, open a nix shell:
+## Run tests
 
-```
-./dev
+```bash
+make test
 ```
 
-Configuration
--------------
+## Configuration
 
 See [application.conf](application.conf).
 
-Email
------
+## Email
 
 `sendmail` command is used for notifications.
-- 
cgit v1.2.3