From 01f7d228b1c013c6cfbb1be6f243b678e94a2173 Mon Sep 17 00:00:00 2001
From: Alexandre ZANNI <16578570+noraj@users.noreply.github.com>
Date: Thu, 18 Jan 2024 19:12:10 +0100
Subject: [PATCH] add BA install steps
---
README.md | 27 +++++++++++++++++++++------
1 file changed, 21 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 5b6ae6a..bd82a83 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,7 @@ ___
### 🐳 Docker
+
If you want to use pinkerton in a Docker container, follow this commands:
```
@@ -49,17 +50,28 @@ If you want to use pinkerton in a Docker container, follow this commands:
### ⚙️ Pre-requisites
+
- [Python 3](https://www.python.org/downloads/) installed on your machine.
- Install the libraries with `pip3 install -r requirements.txt`
-### 🎥 Demo
+### ⚫ BlackArch
+
+```
+pacman -Syu pinkerton
+```
+
+
+
+## 🎥 Demo
+
[](https://asciinema.org/a/SDDtLFRPcauGY1Z5WFLcsc0dI)
-### ✨ Features
+## ✨ Features
+
- Works with ProxyChains
- Fast scan
- Low RAM and CPU usage
@@ -68,7 +80,8 @@ If you want to use pinkerton in a Docker container, follow this commands:
-### 📚 To-Do
+## 📚 To-Do
+
- [x] Add more secrets regex pattern
- [ ] Improve JavaScript file extract function
- [ ] Improve pattern match system
@@ -76,7 +89,7 @@ If you want to use pinkerton in a Docker container, follow this commands:
-### 🔨 Contributing
+## 🔨 Contributing
A quick guide of how to contribute with the project.
@@ -91,12 +104,14 @@ A quick guide of how to contribute with the project.
-### 🙏 Credits
+## 🙏 Credits
+
- [m4ll0k (SecretFinder creator)](https://github.com/m4ll0k) for the regex patterns
- [h33lit (Jubaer Alnazi)](https://github.com/h33tlit) for the regex patterns
- [zricethezav (GitLeaks creator)](https://github.com/zricethezav/gitleaks) for the regex patterns
-### ⚠️ Warning
+## ⚠️ Warning
+
- The developer is not responsible for any malicious use of this tool.