diff --git a/README.md b/README.md index 40d13a8..ce894a6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ -![build](https://github.com/ibnaleem/gosearch/actions/workflows/go.yml/badge.svg?event=push) -# GoSearch -OSINT tool for searching usernames across social networks, written in Go. This project heavily relies on contributors, please see [Contributing](#contributing) for more details. +

+
+This project heavily relies on contributors, please see Contributing for more details.
+git clone https://github.com/ibnaleem/gosearch.git && cd gosearch && go build && ./gosearch [username] +

+ +

+ GitHub Actions Badge GitHub forks GitHub repo size GitHub License +

+
## Installation & Usage ``` @@ -9,6 +16,7 @@ $ git clone https://github.com/ibnaleem/gosearch.git && cd gosearch ``` $ go build ``` +For Unix: ``` $ ./gosearch ``` @@ -16,6 +24,10 @@ I recommend adding the `gosearch` binary to your `/bin` for universal use: ``` $ sudo mv gosearch ~/usr/bin ``` +For Windows: +``` +C:\Users\***\gosearch> gosearch.exe +``` ## Why GoSearch? GoSearch is based on [Sherlock](https://github.com/sherlock-project/sherlock), the well-known username search tool. However, Sherlock has several shortcomings: