aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README5
1 files changed, 5 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..abc90ea
--- /dev/null
+++ b/README
@@ -0,0 +1,5 @@
+The whispers command is a simple convenience wrapper around the herd
+program. Instead of specifying a file path to the listening socket of a
+running shepherd in the whispers tree, the user simply provides its
+absolute whispers tree path as an argument to the --lieutenant option of
+this command.