From e9eb7d32cefb7b10ac7f89e3b5bc14db177b4244 Mon Sep 17 00:00:00 2001 From: Paul Pfeister Date: Wed, 28 Aug 2024 00:25:55 -0400 Subject: [PATCH 1/2] docs: update readme for fedora, parrot, 24.04 --- docs/README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 3090a15..a5d1ef9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,14 +22,18 @@ ## Installation +> [!WARNING] +> Packages for ParrotOS and Ubuntu 24.04, maintained by a third party, appear to be __broken__. +> Users of these systems should defer to pipx/pip or Docker. -| | Command | Notes | +| Method | Notes | Status | | - | - | - | -| PyPI | `pipx install sherlock-project` | `pip` may be used in place of `pipx` | -| Docker | `docker pull sherlock/sherlock` | | -| Debian family | `apt install sherlock` | Kali, Parrot, Debian Testing and Sid | -| BlackArch | `pacman -S sherlock` | | -| Homebrew | `brew install sherlock` | | +| `pipx install sherlock-project` | `pip` may be used in place of `pipx` | Official | +| `docker run -it sherlock/sherlock` | | Official | +| `dnf install sherlock-project` | | Official | +| `apt install sherlock` | | Community | +| `pacman -S sherlock` | | Community | +| `brew install sherlock` | | Community | See all alternative installation methods [here](https://sherlockproject.xyz/installation) From 5990cf1e8ebfb19ebef78610f348f09c4ac63444 Mon Sep 17 00:00:00 2001 From: Paul Pfeister Date: Mon, 11 Nov 2024 17:06:46 -0500 Subject: [PATCH 2/2] docs: cleanup install ref --- docs/README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index a5d1ef9..0fa75ec 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,18 +26,17 @@ > Packages for ParrotOS and Ubuntu 24.04, maintained by a third party, appear to be __broken__. > Users of these systems should defer to pipx/pip or Docker. -| Method | Notes | Status | -| - | - | - | -| `pipx install sherlock-project` | `pip` may be used in place of `pipx` | Official | -| `docker run -it sherlock/sherlock` | | Official | -| `dnf install sherlock-project` | | Official | -| `apt install sherlock` | | Community | -| `pacman -S sherlock` | | Community | -| `brew install sherlock` | | Community | +| Method | Notes | +| - | - | +| `pipx install sherlock-project` | `pip` may be used in place of `pipx` | +| `docker run -it --rm sherlock/sherlock` | +| `dnf install sherlock-project` | | + +Community-maintained packages are available for Debian (>= 13), Ubuntu (>= 22.10), Homebrew, Kali, and BlackArch. These packages are not directly supported or maintained by the Sherlock Project. See all alternative installation methods [here](https://sherlockproject.xyz/installation) -## Usage +## General usage To search for only one user: ```bash