Add insult option to doas.conf

[opendoas.git] / README.md

diff --git a/README.md b/README.md
index 3498f1ca3f39be4427bf014d4758e361666aeadd..0fc94cfe3271dc1a0c673497e66809bcb05eced7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,30 @@
-# 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.
 
-At the moment only linux with GLIBC or musl libc is supported and tested.
+This fork insults you, similar to `sudo`. To enable, add the "insult" option
+to your `doas.conf`
+
+## Building and installation discouragements
 
-## Building and installing
+There are a few steps you have to carefully consider before building and installing
+opendoas:
 
-```
-$ ./configure
-$ make
-# make install
-```
+* There are less eyes on random doas ports, just because sudo had a vulnerability
+  does not mean random doas ports are more secure if they are not reviewed
+  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.
+* 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.
 
 ## About the port
 
@@ -41,7 +52,7 @@ test it yourself.
 A good starting point is probably the distribution maintained `/etc/pam.d/sudo`
 file.
 
-### Perist/Timestamp/Timeout
+### Persist/Timestamp/Timeout
 
 The persist feature is disabled by default and can be enabled with the configure
 flag `--with-timestamp`.