aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2018-06-17 23:24:47 +0200
committerJoris2018-06-18 11:13:55 +0200
commit0a4d3c8f12dc5797a919a00b6bcaf759947687cc (patch)
treebcb89781e22c2314bf0c064ebb37cb7f8a362f5c /README.md
parente2a5c7c5c596d057b6fa9c08a8204ce1429cfdc4 (diff)
downloadad-listener-0a4d3c8f12dc5797a919a00b6bcaf759947687cc.tar.gz
ad-listener-0a4d3c8f12dc5797a919a00b6bcaf759947687cc.tar.bz2
ad-listener-0a4d3c8f12dc5797a919a00b6bcaf759947687cc.zip
Add ouest france parser
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 18 insertions, 16 deletions
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.