aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index d3fad7f..ceb0648 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
leboncoin-listener
==================
+
+leboncoin-listener listen for changes at a given URL on the website leboncoin.
+
+Usage
+-----
+
+```
+cabal sandbox init
+cabal install --only-dependencies
+cabal build
+./dist/build/leboncoin-listener/leboncoin-listener
+```
+
+Configuration
+-------------
+
+You provide the url you want to listen in a file named conf, for example:
+
+```
+url = http://www.leboncoin.fr/locations/offres/ile_de_france/?f=a&th=1
+```