Add preview to readme

Pendragonz · Jun 28, 2020 · 9283b89 · 9283b89
1 parent 8de718d
commit 9283b89
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
 # password-checking-tool
 Check if your passwords have been exposed in data breaches
+
+Use this tool to check if your passwords are included in any data breaches, and if they are, how many times they occur.
+
+The tool generates a SHA1 hash of your password locally and queries pwnedpassword.com's API using the first 5 characters of the hash.
+
+
+![Application at work](readme/preview.png)
diff --git a/readme/preview.png b/readme/preview.png