From c2edf28e6ad42c12a27c46bf25353e228b2958c2 Mon Sep 17 00:00:00 2001
From: Rudis Muiznieks <rudis@sitosis.com>
Date: Tue, 8 Feb 2022 16:37:13 -0600
Subject: [PATCH] updated readme

---
 README.md                    | 29 ++++++++++++++++++++++++++++-
 vocab/en-us/RunScript.intent |  1 +
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f458d02..8fab283 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,30 @@
 # mycroft-run-script
 
-A [Mycroft.ai](https://mycroft.ai) skill to run an arbitrary shell script.
\ No newline at end of file
+A [Mycroft.ai](https://mycroft.ai) skill to run an arbitrary shell script.
+
+## Setup
+
+After installing the skill configure the `script_dir` either in the settings json or on Mycroft Home. Default is `/home/mycroft/scripts`.
+
+Place your executable scripts or programs in that directory with the name you want to call them. Replace spaces with dashes.
+
+## Usage Examples
+
+```
+Hey Mycroft, run the backup script.
+```
+
+This will execute the script `/home/mycroft/scripts/backup` if it exists.
+
+```
+Hey Mycroft, execute total wipe program.
+```
+
+This will execute the script `/home/mycroft/total-wipe` if it exists.
+
+## Todo
+
+- Check if script is still running or not
+- Check if script exited with succes or failure
+- Track multiple scripts simultaneously
+- Save script output with ability to read it back later?
diff --git a/vocab/en-us/RunScript.intent b/vocab/en-us/RunScript.intent
index 5e92ded..bef9769 100644
--- a/vocab/en-us/RunScript.intent
+++ b/vocab/en-us/RunScript.intent
@@ -1,2 +1,3 @@
 (run|execute) (the|my|your) {script} (script|program)
+
 (run|execute) {script} (script|program)