Skip to content

Commit 4279379

Browse files
authored
Merge pull request #2184 from sherlock-project/cleanup
removed content thats on sherlockproject.xyz
2 parents affbf50 + 7021ec2 commit 4279379

File tree

5 files changed

+22
-659
lines changed

5 files changed

+22
-659
lines changed

docs/CONTRIBUTING.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

docs/INSTALL.md

Lines changed: 0 additions & 115 deletions
This file was deleted.

docs/README.md

Lines changed: 22 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,16 @@
22
<br>
33
<a href="https://sherlock-project.github.io/" target="_blank"><img src="images/sherlock-logo.png"/></a>
44
<br>
5-
<span>Hunt down social media accounts by username across <a href="https://github.com/sherlock-project/sherlock/blob/master/docs/sites.md">400+ social networks</a></span>
5+
<span>Hunt down social media accounts by username across <a href="https://sherlockproject.xyz/sites">400+ social networks</a></span>
66
<br>
77
</p>
88

99
<p align="center">
10-
<a href="https://github.com/sherlock-project/sherlock#installation">Installation</a>
11-
&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
12-
<a href="https://github.com/sherlock-project/sherlock#usage">Usage</a>
13-
&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
14-
<a href="https://github.com/ppfeister/sherlock/blob/feature/docu/docs/INSTALL.md#docker">Docker</a>
15-
&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
16-
<a href="https://github.com/ppfeister/sherlock/blob/feature/docu/docs/CONTRIBUTING.md">Contributing</a>
10+
<a href="https://sherlockproject.xyz/installation">Installation</a>
11+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
12+
<a href="https://sherlockproject.xyz/usage">Usage</a>
13+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
14+
<a href="https://sherlockproject.xyz/contribute">Contributing</a>
1715
</p>
1816

1917
<p align="center">
@@ -24,8 +22,6 @@
2422

2523
## Installation
2624

27-
[![PyPI - Version](https://img.shields.io/pypi/v/sherlock-project?logo=PyPi&label=PyPI&color=darkgreen)][ext_pypi] [![Docker Image Version](https://img.shields.io/docker/v/sherlock/sherlock?sort=semver&logo=docker&label=Docker&color=darkgreen)][docs_docker] [![homebrew version](https://img.shields.io/homebrew/v/sherlock?logo=Homebrew&color=darkgreen)][ext_brew]
28-
2925

3026
| | Command | Notes |
3127
| - | - | - |
@@ -35,17 +31,21 @@
3531
| BlackArch | `pacman -S sherlock` | |
3632
| Homebrew | `brew install sherlock` | |
3733

38-
PyPI and DockerHub images are mainaintenced by the Sherlock Project. Others are community supported.
39-
40-
### Alternative guides and methods
34+
See all alternative installation methods [here](https://sherlockproject.xyz/installation)
4135

42-
- [See all alternative guides][docs_install]
43-
- [Python package][docs_py]
44-
- [Docker container][docs_docker]
36+
## Usage
4537

38+
To search for only one user:
39+
```bash
40+
sherlock user123
41+
```
4642

43+
To search for more than one user:
44+
```bash
45+
sherlock user1 user2 user3
46+
```
4747

48-
## Usage
48+
Accounts found will be stored in an individual text file with the corresponding username (e.g ```user123.txt```).
4949

5050
```console
5151
$ sherlock --help
@@ -96,31 +96,13 @@ optional arguments:
9696
--nsfw Include checking of NSFW sites from default list.
9797
```
9898

99-
To search for only one user:
100-
```bash
101-
sherlock user123
102-
```
103-
104-
To search for more than one user:
105-
```bash
106-
sherlock user1 user2 user3
107-
```
99+
## Credits
108100

109-
Accounts found will be stored in an individual text file with the corresponding username (e.g ```user123.txt```).
110-
111-
112-
## How to contribute to Sherlock
113-
114-
We would love to have you help us with the development of Sherlock. Each and every contribution is greatly valued!
101+
Thank you to everyone who has contributed to Sherlock! ❤️
115102

116-
Here are some things we would appreciate your help on:
117-
- [Adding targets][docs_contrib_adding_targets]
118-
- [Cleaning up existing targets][docs_contrib_removing_targets]
119-
- [Restoring previously removed targets][docs_contrib_restoring_targets]
120-
121-
Head over to our __[Contributing][docs_contrib]__ page for additional info.
122-
123-
## Star History
103+
<a href="https://github.com/sherlock-project/sherlock/graphs/contributors">
104+
<img src="https://contrib.rocks/image?&columns=25&max=10000&&repo=sherlock-project/sherlock" noZoom />
105+
</a>
124106

125107
<picture>
126108
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=sherlock-project/sherlock&type=Date&theme=dark" />
@@ -135,12 +117,5 @@ Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)
135117

136118
<!-- Reference Links -->
137119

138-
[docs_install]: /docs/INSTALL.md
139-
[docs_docker]: /docs/INSTALL.md#docker
140-
[docs_py]: /docs/INSTALL.md#python
141-
[docs_contrib]: /docs/CONTRIBUTING.md
142-
[docs_contrib_adding_targets]: /docs/CONTRIBUTING.md#adding-targets
143-
[docs_contrib_removing_targets]: /docs/CONTRIBUTING.md#removing-targets
144-
[docs_contrib_restoring_targets]: /docs/CONTRIBUTING.md#restoring-targets
145120
[ext_pypi]: https://pypi.org/project/sherlock-project/
146121
[ext_brew]: https://formulae.brew.sh/formula/sherlock

docs/images/preview.png

284 KB
Loading

0 commit comments

Comments
 (0)