Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
danielkvist committed Sep 9, 2019
1 parent d9e98e6 commit a4299d0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 18 deletions.
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Beagle

[![Go Report Card](https://goreportcard.com/badge/github.com/danielkvist/beagle)](https://goreportcard.com/report/github.com/danielkvist/beagle)
[![CircleCI](https://circleci.com/gh/danielkvist/beagle.svg?style=svg)](https://circleci.com/gh/danielkvist/beagle)
[![GoDoc](https://godoc.org/github.com/danielkvist/beagle?status.svg)](https://godoc.org/github.com/danielkvist/beagle)
[![Docker Pulls](https://img.shields.io/docker/pulls/danielkvist/beagle.svg?maxAge=604800)](https://hub.docker.com/r/danielkvist/beagle/)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
Expand All @@ -13,7 +14,7 @@
^^^^^^^^^^^^^^^^^^
```

Beagle is simple Go cli to search for an especific username accross the Internet.
Beagle is a CLI writen in Go to search for an especific username accross the Internet.

> Beagle is a project inspired by [Sherlock](https://github.com/sherlock-project/sherlock).
Expand All @@ -28,9 +29,17 @@ beagle -g 10 -t 1s -u me -v
### Go

```bash
go get github.com/danielkvist/beagle
go install github.com/danielkvist/beagle
```

### Docker

```bash
docker image pull danielkvist/beagle
```

> Note that the image danielkvist/beagle uses the urls.csv file from this repository. So it is not a valid option if you want to customize the URLs that beagle is gonna to use.
### Cloning the repository

```bash
Expand All @@ -47,26 +56,18 @@ go run main.go
go install
```

### Docker

```bash
docker image pull danielkvist/beagle
```

> Note that the image danielkvist/beagle uses the urls.csv file from this repository. So it is not a valid option if you want to customize the URLs that beagle is gonna to use.
## Building the Docker image

```bash
# Inside the beagle directory, after cloning the git repository
# Inside the beagle directory, after cloning the git repository:
docker image build -t beagle .
```

## Options

```text
$ beagle --help
beagle is simple Go CLI to search for an especific username accross the Internet.
Beagle is a CLI writen in Go to search for an especific username accross the Internet.
Usage:
beagle [flags]
Expand Down Expand Up @@ -96,17 +97,13 @@ The format of the ```.csv``` file, if you do not want to use the one provided by
name, mainURL, userURL
```

The URL must contain a ```$``` where the username should go, for example:
The URLs must contain a ```$``` where the username should go, for example:

```csv
instagram,https://instagram.com/$,https://instagrma.com/$
devianart,https://$.devianart.com,https://$.devianart.com
```

## False positives

Some sites return an HTTP status code ```200 OK``` even if the user had not been found or doesn't exist. This causes Beagle to report that the user has been found even though this has not been the case.

## Use Beagle with responsability

Beagle is a tool whose use I am not responsible for. And that has been built for the sole purpose of learning more about Go.
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func Root() *cobra.Command {

root := &cobra.Command{
Use: "beagle",
Short: "Beagle is a Go CLI to search for an especific username accross the Internet.",
Short: "Beagle is a CLI writen in Go to search for an especific username accross the Internet.",
Example: "beagle -g 10 -t 1s -u me -v",
RunE: func(cmd *cobra.Command, args []string) error {
c, err := client.New(client.WithTimeout(timeout), client.WithProxy(proxy))
Expand Down

0 comments on commit a4299d0

Please sign in to comment.