From 2715c9f05b61efced9c3ab02a7db4c1e7841d0e5 Mon Sep 17 00:00:00 2001
From: Jan Seipel <jan.seipel@swr.de>
Date: Tue, 9 Jul 2024 12:32:18 +0000
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..2e64a01
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# netzradar-yourls-downloader
+
+Plugin, um die Daten aus unserer Yourls-Instanz als CSV herunterzuladen. 
+
+# Installation
+
+1. Browsererweiterung Tampermonkey installieren. 
+2. [RAW-Link des Userscripts aufrufen](https://gitlab.ard.de/ida/netzradar-yourls-downloader/-/raw/main/netzradar-yourls-downloader.user.js)
+3. Auf "Installieren" klicken
+
+Eventuell musst du noch den Entwicklermodus aktiviert, damit das Script funktioniert:
+
+1. Rechtsklick auf das Tampermonkey-Icon im Browser
+2. Oben rechts den Schieberegler bei "Entwicklermodus" aktivieren
+3. ggf. ist ein Browserneustart nötig oder die Änderung greift erst nach ein paar Minuten
+
+# Verwendung
+
+Das Plugin fügt einen neuen Button ganz unten neben schon existierenden Buttons ein. Mit einem Klick darauf, lädst du alle sichtbaren Zeilen der Tabelle unter [http://x.swr.de/a/admin/](http://x.swr.de/a/admin/) herunter. Wichtig: standardmäßig sind nur 15 Zeilen sichbar. Um eine größere Menge auf einmal abzurufen, kannst du den Wert unter "Show [...] rows" erhöhen. 
\ No newline at end of file
-- 
GitLab