From 49de34f863dc7f8ea79eec0b60796e8a377ff6c9 Mon Sep 17 00:00:00 2001
From: Luca <Luca@hackerspace-bamberg.de>
Date: Sat, 4 Jan 2025 06:09:18 +0100
Subject: [PATCH] docs: add README.md

---
 .gitignore | 1 +
 README.md  | 8 ++++++++
 2 files changed, 9 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index ea8c4bf..d2380cd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
 /target
+bad_apple.webm
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4300eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# gst-plugin-pingxelflut
+
+```
+GST_PLUGIN_PATH="target/debug:$GST_PLUGIN_PATH" gst-launch-1.0 filesrc location=bad_apple.webm ! matroskademux name=mkv \
+\
+    mkv. ! queue ! av1dec ! videoconvert ! videoscale ! videorate ! video/x-raw,width=96,height=72,framerate=5/1 ! pingxelflutsink 'bind-address=[2001:db8::ffff:ffff:0:2]:1337' prefix=2001:db8:: \
+    mkv. ! queue ! opusdec ! audioconvert ! audioresample ! pulsesink
+```