From ca6f2c2655e8dd208c88cfedfb99136a5d1466e9 Mon Sep 17 00:00:00 2001
From: Cassowary <cassowary@aldercone.studio>
Date: Sat, 30 Mar 2024 21:19:47 -0700
Subject: [PATCH] Document things a bit more!

---
 README.txt            |  8 ++++++++
 multiball.cfg.example | 10 ++++++++++
 multiball/__main__.py |  2 --
 pyproject.toml        |  2 +-
 4 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/README.txt b/README.txt
index 0e5abea..527fae2 100644
--- a/README.txt
+++ b/README.txt
@@ -5,3 +5,11 @@
 |_|  |_|\__,_|_|\__|_|_.__/ \__,_|_|_(_|_)
 
 Run commands across a set of hosts interactively!
+=================================================
+
+Basic configuration file is in multiball.cfg.example in the distribution. Customize to your liking. Host list is loaded from,
+by default, your ssh configuration (assuming you have a specific ssh configuration for your all hosts like Autonomic has). You
+can also use arbitrary host lists (documented in configuration file).
+
+
+Planned features, see __main__.py's comments.
diff --git a/multiball.cfg.example b/multiball.cfg.example
index 66c5797..a97596d 100644
--- a/multiball.cfg.example
+++ b/multiball.cfg.example
@@ -1,9 +1,19 @@
 [config]
+# The path to the file to store history in.
 history=multiball.history
+
+# A comma-separated list of sshconfigs, but really only the first one matters due to a bug.
 sshconfigs=~/.ssh/config
+
+# Bare host lists, one host per line.
+#hostlists=example.txt,example2.txt
 hostlists=
 
 [startup]
+# Commands which run at startup. Not really supported yet. For building aliases and things.
+
+
+### Below are commands, which are a mini-script to execute several commands in a row.
 
 [cmd.upgrade]
 /unsafe
diff --git a/multiball/__main__.py b/multiball/__main__.py
index 382d31e..bfa4384 100644
--- a/multiball/__main__.py
+++ b/multiball/__main__.py
@@ -21,8 +21,6 @@
 # - allow scripts that use -safe to prompt for safety / restore safety after running
 
 
-
-
 import argparse
 import datetime
 import fnmatch
diff --git a/pyproject.toml b/pyproject.toml
index 5431e3c..d87eaf4 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 [project]
 name = "multiball"
 dynamic = ["version"]
-description = "Run commands accross a set of hosts interactively."
+description = "Multi-host parallel execution shell with powerful features."
 authors = [{name = "Cassowary", email="cassowary@riseup.net"}]
 dependencies = ["tqdm", "yaml-1.3", "prompt_toolkit", "fabric2"]
 requires-python = ">=3.8"