From 60684e8280378ab0cac476d83dd4d1df6664c3ea Mon Sep 17 00:00:00 2001
From: Andinus <andinus@nand.sh>
Date: Wed, 14 Apr 2021 13:57:01 +0530
Subject: Document changes in README.org

---
 README.org | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.org b/README.org
index 863286d..6b33738 100644
--- a/README.org
+++ b/README.org
@@ -11,7 +11,14 @@
 
 - Orion v0.1.0 :: https://diode.zone/videos/watch/ffd4021d-2b39-4e6a-993e-3eacf9323320
 
-* Working
+* Documentation
+
+** Implementation
+
+Initially it presented a simple prompt that accepted a password & it
+checked that password against HIBP database. Orion v0.2.0+ checks for
+compromised passwords in my password store. It builds a list of all the
+passwords in =~/.password-store= & performs these operations on each file:
 
 - Password is hashed & split (prefix: [:5], suffix: [5:])
 - Prefix is sent to the HIBP API
@@ -23,6 +30,12 @@ Match means the password is present in HIBP database & has been compromised.
 - *Note*: Password not present in database doesn't mean that it is a
   strong password.
 
+** Options
+
+*** verbose
+
+This option does nothing.
+
 * History
 
 Orion v0.1.0 was a simple cli application that asked user for password &
-- 
cgit 1.4.1-2-gfad0