From 9348d863a57500882b1507c61b5f121acfc94de6 Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Sat, 29 Aug 2020 16:45:43 +0200 Subject: [PATCH] updated README.md - replaced "Adding new sites" section with "Contributing" - removed note about using Python 3.6 or above because Sherlock now automatically checks when it runs --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a984f2e..5668723 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
- Hunt down social media accounts by username across social networks + Hunt down social media accounts by username across social networks
@@ -15,15 +15,13 @@

- Demo -    |    Installation    |    Usage    |    Docker Notes    |    - Adding New Sites + Contributing

@@ -35,8 +33,6 @@ ## Installation -**NOTE**: Python 3.6 or higher is required. - ```console # clone the repo $ git clone https://github.com/sherlock-project/sherlock.git @@ -44,8 +40,6 @@ $ git clone https://github.com/sherlock-project/sherlock.git # change the working directory to sherlock $ cd sherlock -# install python3 and python3-pip if they are not installed - # install the requirements $ python3 -m pip install -r requirements.txt ``` @@ -153,13 +147,16 @@ You can use the `docker-compose.yml` file from the repository and use this comma docker-compose run sherlock -o /opt/sherlock/results/text.txt user123 ``` -## Adding New Sites +## Contributing +We would love to have you help us on the development of Sherlock. Each and every contribution is greatly valued! + +Here are some things we would appriciate your help on: +- Addition of new site support ยน +- Bringing back site support of [sites that have been removed](removed_sites.md) in the past due to false positives -Please look at the Wiki entry on -[adding new sites](https://github.com/TheYahya/sherlock/wiki/Adding-Sites-To-Sherlock) -to understand the issues. -**NOTE**: Sherlock is not accepting adult sites in the standard list. +[1] Please look at the Wiki entry on [adding new sites](https://github.com/sherlock-project/sherlock/wiki/Adding-Sites-To-Sherlock) +to understand the issues. ## Tests