From 76be6c55bcdc3d174f22e90ca6614ab03c7eef26 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Vizcaino?= <jerome.vizcaino@gmail.com>
Date: Fri, 7 Oct 2016 21:52:06 +0200
Subject: [PATCH] Add README

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88ecdb6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# `auvieux-scraper`: extract price and name from a *Au Vieux Campeur* product reference
+
+This is a simple scraper used to extract product name and price given a reference.
+Every product gets printed on stdout as a CSV line
+
+## Usage
+
+```shell
+$ auvieux-scraper 12345 654321
+Référence;Désignation;Prix TTC
+12345;My super item;134
+654321;Other important item;42
+```
+
+## Build
+
+To compile this, you need:
+
+* a working Go (>= 1.6) installation
+* `make`
+* `glide`
+
+```shell
+$ git clone https://github.com/j-vizcaino/auvieux-scraper.git $GOPATH/src/auvieux-scraper
+$ cd $GOPATH/src/auvieux-scraper
+$ make deps
+$ make
+```
+