aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRunciter2024-10-25 02:22:32 +0800
committerRunciter2024-10-25 02:22:32 +0800
commit2b583171c9480e129d0349d1cf9a580a9c8b19e6 (patch)
treeb7b4a2b3a2ac123a0ebb6f63606d2451831e6d10 /README
parentf310e913f82e18cb9e02b48fe4cb0c50178cd1a8 (diff)
downloadwhispers-command-2b583171c9480e129d0349d1cf9a580a9c8b19e6.tar.gz
Change symbolic link to README.org into text README.HEADtrunk
T README D README.org
Diffstat (limited to 'README')
-rw-r--r--[l---------]README6
1 files changed, 5 insertions, 1 deletions
diff --git a/README b/README
index 314e17d..abc90ea 120000..100644
--- a/README
+++ b/README
@@ -1 +1,5 @@
-README.org \ No newline at end of file
+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.