Skip to content

Commit a6dc387

Browse files
committed
Readability changes to README.md
1 parent 07e0472 commit a6dc387

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Github Dorks
2-
[Github search](https://github.com/search) is quite powerful and useful feature and can be used to search sensitive data on the repositories. Collection of github dorks that can reveal sensitive personal and/or organizational information such as private keys, credentials, authentication tokens, etc. This list is supposed to be useful for assessing security and performing pen-testing of systems.
2+
[Github Search](https://github.com/search) is a quite powerful and useful feature that can be used to search for sensitive data on repositories. Collection of Github dorks can reveal sensitive personal and/or organizational information such as private keys, credentials, authentication tokens, etc. This list is supposed to be useful for assessing security and performing pen-testing of systems.
33

44
### GitHub Dork Search Tool
5-
[github-dork.py](github-dork.py) is a simple python tool that can search through your repository or your organization/user repositories. Its not a perfect tool at the moment but provides a basic functionality to automate the search on your repositories against the dorks specified in text file.
5+
[github-dork.py](github-dork.py) is a simple python tool that can search through your repository or your organization/user repositories. It's not a perfect tool at the moment but provides a basic functionality to automate the search on your repositories against the dorks specified in text file.
66

77
#### Installation
88
This tool uses [github3.py](https://github.com/sigmavirus24/github3.py) to talk with GitHub Search API.
@@ -14,18 +14,18 @@ pip install -r requirements.txt
1414

1515
#### Usage
1616
```
17-
GH_USER - Environment variable to specify github user
17+
GH_USER - Environment variable to specify Github user
1818
GH_PWD - Environment variable to specify password
19-
GH_TOKEN - Environment variable to specify github token
19+
GH_TOKEN - Environment variable to specify Github token
2020
GH_URL - Environment variable to specify GitHub Enterprise base URL
2121
```
2222

2323
Some example usages are listed below:
2424

2525
```shell
26-
python github-dork.py -r techgaun/github-dorks # search single repo
26+
python github-dork.py -r techgaun/github-dorks # search a single repo
2727

28-
python github-dork.py -u techgaun # search all repos of user
28+
python github-dork.py -u techgaun # search all repos of a user
2929

3030
python github-dork.py -u dev-nepal # search all repos of an organization
3131

@@ -43,10 +43,10 @@ GH_URL=https://github.example.com python github-dork.py -u dev-nepal # search
4343
- ~~Handle rate limit and retry. PR welcome~~
4444

4545
### Contribution
46-
Please consider contributing the dorks that can reveal potentially sensitive information in github.
46+
Please consider contributing dorks that can reveal potentially sensitive information on Github.
4747

4848
### List of Dorks
49-
I am not categorizing at the moment. Instead I am going to just the list of dorks with a description. Many of the dorks can be modified to make the search more specific or generic. You can see more options [here](https://github.com/search#search_cheatsheet_pane).
49+
I am not categorizing at the moment. Instead, I am going to just the list of dorks with a description. Many of the dorks can be modified to make the search more specific or generic. You can see more options [here](https://github.com/search#search_cheatsheet_pane).
5050

5151
Dork | Description
5252
------------------------------------------------|--------------------------------------------------------------------------

0 commit comments

Comments
 (0)