summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRunciter2025-07-03 23:58:23 +0800
committerRunciter2025-07-03 23:58:23 +0800
commit63dc81e2b164514ca855712841209eec7e6ae9d3 (patch)
treeb7b4a2b3a2ac123a0ebb6f63606d2451831e6d10 /README
downloadwhispers-command-0.1.tar.gz
A .gitignore A AUTHORS A COPYING A ChangeLog A HACKING A Makefile.am A NEWS A README A build-aux/test-driver.scm A configure.ac A guix.scm A hall.scm A pre-inst-env.in A scripts/whispers.in A whispers.scm A whispers/hconfig.scm Signed-off-by: Runciter <runciter@whispers-vpn.org>
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.