summaryrefslogtreecommitdiff
path: root/examples/Info/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/Info/README.md')
-rw-r--r--examples/Info/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/examples/Info/README.md b/examples/Info/README.md
new file mode 100644
index 00000000..b3fff703
--- /dev/null
+++ b/examples/Info/README.md
@@ -0,0 +1,10 @@
+# Information example
+
+This example will show how to get some basic information sent to the UI.<br/>
+
+The Plugin has a lot of parameter outputs which the UI uses to get info from.<br/>
+This includes buffer-size and time position.<br/>
+Sample-rate can be requested directly from the UI.<br/>
+The UI will show this information as text.<br/>
+
+The plugin will not do any audio processing.<br/>