aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..17d6e05
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+## **pwndb - Get Mail Credentials**
+Search for leaked passwords from an email
+
+### Prerequisities
+To use in Linux (Kali/Ubuntu/Debian) you should to run make script:
+```
+chmod +x make.sh
+./make.sh
+```
+
+### Usage
+```[python]
+python3 pwndb_credentials.py -m mail@mail.com [-p socks5h://localhost:9050]
+```