From b54e5165c443806a0e92a92cebec20cc91ba80cb Mon Sep 17 00:00:00 2001
From: Julius Freudenberger <julius+git@jfreudenberger.de>
Date: Mon, 15 May 2023 14:16:39 +0200
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b871287
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Rewe Vereinsscheine Fetcher
+Get information for the Campaign 'Scheine für Vereine' of Rewe.
+Finds 'Vereine' in the given location and exports their address and 'Scheine' information.
+
+## Usage
+```bash
+./main.py <latitude> <longitude> [--export-file <file>]
+```
+
+This generates a csv-file with the following structure:
+`account_name,address,post_code,city,total_balance,available_balance,redeemed`
+
+## Background information
+More information about the campaign can be found on the [corresponding page](https://scheinefuervereine.rewe.de/).
+
+The API endpoints used are:
+`https://scheinefuervereine.rewe.de/consumer-api/customer.php?action=get_club&id=<id>`
+and
+`https://scheinefuervereine.rewe.de/consumer-api/customer.php?action=get_clubs_near_location&count=<count>&lat=<latitude>&long=<longitude>`