Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ibnaleem authored Dec 9, 2024
1 parent 5fc28ba commit 2da5976
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
<p align='center'>
<img src='img/gosearch-logo.png' height=50% width=50%><br>
<i>This project heavily relies on contributors, please see <a href="#contributing">Contributing</a> for more details.</i><br>
<code>git clone https://github.com/ibnaleem/gosearch.git && cd gosearch && go build && ./gosearch [username]</code>
</p>

<p align="center">
<img src="https://github.com/ibnaleem/gosearch/actions/workflows/go.yml/badge.svg?event=push" alt="GitHub Actions Badge"> <img src="https://img.shields.io/github/last-commit/ibnaleem/gosearch"> <img src="https://img.shields.io/github/commit-activity/w/ibnaleem/gosearch"> <img src="https://img.shields.io/github/contributors/ibnaleem/gosearch"> <img alt="GitHub forks" src="https://img.shields.io/github/forks/ibnaleem/gosearch"> <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/ibnaleem/gosearch"> <img alt="GitHub License" src="https://img.shields.io/github/license/ibnaleem/gosearch">
</p>
<hr>

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

Expand Down

0 comments on commit 2da5976

Please sign in to comment.