summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-04-14 13:57:01 +0530
committerAndinus <andinus@nand.sh>2021-04-14 13:57:59 +0530
commit60684e8280378ab0cac476d83dd4d1df6664c3ea (patch)
tree53131836d7e5ec0f0b4c668ecdc9145704dd81c2
parent5c390d9d6bd7b4f428caaa288b5ab9a03bdaa842 (diff)
downloadorion-60684e8280378ab0cac476d83dd4d1df6664c3ea.tar.gz
Document changes in README.orgv0.2.0
-rw-r--r--README.org15
1 files changed, 14 insertions, 1 deletions
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 &