From 3922e8d52d0b3f4af242ef326fb615417ae022fb Mon Sep 17 00:00:00 2001
From: Benjamin Ver <BenjaminVermunicht@gmail.com>
Date: Mon, 28 Sep 2020 11:31:20 +0200
Subject: [PATCH] added short readme

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 2ed42ed..1509a3b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,9 @@
 # speech2command
+
+Tool to convert sproken commands to actual commands in Azumuta. Using Kaldi ASR models and Vosk-API.
+
+## Usage
+
+VoskJS.js defines a recognizer for the model and should be loaoded first.
+resultHandling converts the model to actual commands. Commands can be added with `addToCommand(text, command)`, where `command` is the command for Azumuta and text is a list with words (defined in red<LANG>.js).
+To load the English model, load redEn.js; this will load the model and define the appropriate words. To use Dutch, load redNl.js instead.
\ No newline at end of file