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