diff --git a/docs/pyproj/README.md b/docs/pyproj/README.md new file mode 100644 index 00000000..446382f5 --- /dev/null +++ b/docs/pyproj/README.md @@ -0,0 +1,46 @@ + + +

+
+ +
+ Hunt down social media accounts by username across social networks +
+ Additional documentation can be found on our GitHub repository +
+

+ +

+ + +

+ +## Usage + +```console +$ sherlock --help +usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT] + [--output OUTPUT] [--tor] [--unique-tor] [--csv] [--xlsx] + [--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE] + [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color] + [--browse] [--local] [--nsfw] + USERNAMES [USERNAMES ...] +``` + +To search for only one user: +```bash +$ sherlock user123 +``` + +To search for more than one user: +```bash +$ sherlock user1 user2 user3 +``` + +## Star History + + + + + Sherlock Project Star History Chart + diff --git a/pyproject.toml b/pyproject.toml index 2cf59298..7356c0d1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,18 +11,17 @@ Repository = "https://github.com/sherlock-project/sherlock.git" Issues = "https://github.com/sherlock-project/sherlock/issues" [project] -name = "Sherlock" +name = "sherlock-project" authors = [ - { name = "Sherlock Project" } + { name = "Siddharth Dushantha" } ] maintainers = [ - { name = "Siddharth Dushantha" }, { name = "Matheus Felipe" }, { name = "Sondre Karlsen Dyrnes" }, { name = "Paul Pfeister" } ] description = "Hunt down social media accounts by username across social networks" -readme = "README.md" +readme = "docs/pyproj/README.md" # Do not set license to file. Causes issues with rpm packaging for some reason. license = {text = "MIT"} dynamic = ["dependencies", "version"]