aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0ac230d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+## Dumb Voice Protocol
+
+# Intro
+
+This is a CLI program that reads your microphone device and outputs information to stdout / ipc.
+
+# Usage
+
+```
+dmvop --output=stdout --fmt="%{vol},%{word},%{confidence}" --device="/dev/mymic"
+ --output=stderr --fmt-file="./fmt.txt"
+ --output=ipc
+ --output=tcp
+ --output=udp
+```
+
+# License
+
+Under WTFPL