]> gitweb.michael.orlitzky.com - mailshears.git/commitdiff
doc/README.rst: minor wording update master codeberg/master
authorMichael Orlitzky <michael@orlitzky.com>
Tue, 24 Feb 2026 19:56:55 +0000 (14:56 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Tue, 24 Feb 2026 19:57:06 +0000 (14:57 -0500)
doc/README.rst

index 4a119b74467809324e907f3ddf458d8408724962..49554d28028b7a77332578058cfafe2fb5c52814 100644 (file)
@@ -35,18 +35,13 @@ and Roundcube, but they are all optional.
 How it works
 ============
 
-Each plugin knows how to do perform actions:
+Each plugin knows how to perform three actions: prune, rename, and
+remove.  Mailshears figures out which plugins need to be run, and then
+runs them in succession.
 
-* prune
-* rename
-* remove
-
-Depending on how you invoke mailshears, it figures out which plugins
-need to be run, and then runs them in succession.
-
-By default, mailshears won't actually do anything. There's a variable
-``i_mean_business: false`` in the config file that must be set to
-``true`` before mailshears will modify the system.
+By default, mailshears won't actually do anything. There's an
+``i_mean_business: false`` setting in the config file that must be set
+to ``true`` before mailshears will modify the system.
 
 
 Examples