README

README.md

@@ -1,7 +1,26 @@
 
-# Sherlock
 
-the sherlock tool but writen in rust because I wanted a single binary
+<p align=center>
+  <br>
+  <a href="https://sherlock-project.github.io/" target="_blank"><img src="docs/images/sherlock-logo.png"/></a>
+  <br>
+  <span>Hunt down social media accounts by username across <a href="https://sherlockproject.xyz/sites">400+ social networks</a></span>
+  <br>
+</p>
+
+<p align="center">
+  <a href="https://sherlockproject.xyz/installation">Installation</a>
+  &nbsp;&nbsp;&nbsp;•&nbsp;&nbsp;&nbsp;
+  <a href="https://sherlockproject.xyz/usage">Usage</a>
+  &nbsp;&nbsp;&nbsp;•&nbsp;&nbsp;&nbsp;
+  <a href="https://sherlockproject.xyz/contribute">Contributing</a>
+</p>
+
+<p align="center">
+<img width="70%" height="70%" src="docs/images/demo.png"/>
+</a>
+</p>
+
 
 ## Usage
 

src/get_data.rs

@@ -54,7 +54,7 @@ pub async fn get_json_data(json_file: String) -> color_eyre::Result<String> {
     Ok(json_str)
 }
 
-/// the default sites to check for sherlock
+/// the default sites to check for sherlock locally
 /// includes >400 websites and their error messages
 pub fn get_default_data() -> String {
     r#"