Add insult option to doas.conf

[opendoas.git] / README.md

diff --git a/README.md b/README.md
index 5695803fc6cb8e6fa6b0de4c532648bd40786cc3..0fc94cfe3271dc1a0c673497e66809bcb05eced7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,15 @@
-# OpenDoas: a portable version of OpenBSD's `doas` command
+# OpenDoas
+
+> a portable version of OpenBSD's `doas` command
 
 `doas` is a minimal replacement for the venerable `sudo`. It was
 initially [written by Ted Unangst](http://www.tedunangst.com/flak/post/doas)
 of the OpenBSD project to provide 95% of the features of `sudo` with a
 fraction of the codebase.
 
+This fork insults you, similar to `sudo`. To enable, add the "insult" option
+to your `doas.conf`
+
 ## Building and installation discouragements
 
 There are a few steps you have to carefully consider before building and installing
@@ -15,8 +20,8 @@ opendoas:
   or pam is configured incorrectly.
 * If you want to use pam; You have to [configure pam](#pam-configuration)
   and failing to do so correctly might leave a big open door.
-* Use the configure script to configure the opendoas.
-* Use the default make target to build the software.
+* Use the configure script.
+* Use the default make target.
 * If you really want to install a setuid binary that depends on
   pam being correctly configured, use the make install target
   to install the software.