From d96d8623836b8bfa0060df32abe08eba30b0e34d Mon Sep 17 00:00:00 2001
From: lily <gentop>
Date: Wed, 13 Aug 2025 11:22:01 +1000
Subject: [PATCH] fix readme

---
 README.md | 39 +++++++--------------------------------
 1 file changed, 7 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md
index d0eb07c..7c48f3d 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
-# RootDO [![AUR](https://img.shields.io/aur/version/rdo.svg)](https://aur.archlinux.org/packages/rdo/)
+# RootDO
 
 This project aims to be a very slim alternative to both sudo and doas.
 
 ### Installation
 
-If you are on Arch Linux, you can download the package via the [AUR](https://aur.archlinux.org/packages/rdo/).
-
 You can clone and build rdo with the following set of commands:
 
 ```sh
@@ -37,6 +35,8 @@ Or, to get the password from stdin:
 rdo - [command]
 ```
 
+`rdo` will ask for your password and grant you a session, on successful authentication you will be able to use `rdo` for the time specified in `session_ttl`. You have 3 attempts to enter the correct password.
+
 The configuration file has the following variables:
 ```
 group=wheel
@@ -45,34 +45,9 @@ session_ttl=5
 ```
 
 - `group`: The group of users that is allowed to execute rdo.
-- `wrong_pw_sleep`: The amount of milliseconds to sleep at a wrong password attempt. Must be a positive integer. Set to 0 to disable.
-- `session_ttl`: The amount of minutes a session lasts. Must be a positive integer. Set to 0 to disable.
+- `wrong_pw_sleep`: The amount of milliseconds to sleep at a wrong password attempt. Must be a positive integer. Set to 0 to disable. Defaults to 1000.
+- `session_ttl`: The amount of minutes a session lasts. Must be a positive integer. Set to 0 to disable. Defaults to 5.
 
-### Benchmarks
+### License
 
-The benchmark: Execute `whoami` (GNU coreutils 9.1) 10000 times.
-
-Yes, this is a silly benchmark. Yes, the performance gain in real world application is close to nothing.
-
-But it's fun!
-
-|Program|Time|
---- | --- 
-sudo 1.19.11 | 46.85s
-doas 6.8.2 | 32.57s
-rdo 1.4.2 | 13.37s
-Baseline | 7.95s
-
-> Baseline here is how long it took without any wrapper to make it root.
-
-These benchmarks were done on a `Intel i5 7200U` processor, on a Debian 12 Docker container.
-
-`sudo` and `doas` were pulled from the Debian repos, `rdo` was compiled locally.
-
-All configs were kept as default, except allow the `wheel` group on both + enable `persist` on doas.
-
-The benchmark can be executed through a Docker container by running:
-
-```
-make bench-build bench-run
-```
+This project is licensed under the GNU General Public License v3.0. See the `LICENSE` file for the full license text.