Skip to content

Commit de7aa27

Browse files
committed
updated readme.md
1 parent f569c56 commit de7aa27

File tree

1 file changed

+15
-27
lines changed

1 file changed

+15
-27
lines changed

README.md

+15-27
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,35 @@
11
**About**
22

3-
43
This is a web vulnerability scanner framework built on flask. It helps you scan a website for trivial security issues like simple XSS, sqli (in GET requests), directory traversal.
5-
There are options for subdomain enumeration and port scanning too. The *complete scan*" option does all of the 5 scans and generates a pdf report for the same.
4+
There are options for subdomain enumeration and port scanning too. The _complete scan_" option does all of the 5 scans and generates a pdf report for the same.
65

76
**Dependencies**:
87

8+
1.[pip3](https://pip.pypa.io/en/stable/installing/#)
99

10-
1.[pip3](https://pip.pypa.io/en/stable/installing/#)
11-
12-
13-
2.Beautifulsoup
14-
15-
16-
3.Flask
17-
10+
2.[Beautifulsoup](https://pypi.org/project/beautifulsoup4/)
1811

19-
4.wkhtmltopdf
12+
3.[Flask](https://pypi.org/project/Flask/)
2013

14+
4.[wkhtmltopdf](https://wkhtmltopdf.org/downloads.html)
2115

22-
5.request module
16+
5.[request module](https://pypi.org/project/requests/)
2317

18+
6.[socket module](https://pypi.org/project/sockets/)
2419

25-
6.socket module
26-
27-
28-
7.threading module
29-
20+
7.[threading module](https://pypi.org/project/threaded/)
3021

3122
Please install all of the above for smooth functioning of the frameowrk.
3223

3324
**Setup**
3425

35-
Install all the dependencies, then run ` python3 index.py `
36-
26+
Install all the dependencies, then run `python3 index.py`
3727

3828
**Contributing Guidelnines**
3929

40-
1. Fork this Repository.
41-
1. Select an issue or create an issue on which you want to work. Discuss with the maintainers.
42-
1. Before submitting a pull request, pleasecreate a seperate branch using ` git checkout -b <name-of-the-new-branch> `
43-
1. To commit changes: ` git commit -m "<a verbose message explaining which issue is being fixed by this commit> `
44-
1. To push the changes:` git push origin <your-branch-name> `
45-
1. Create a pull request on the repository wait for it to get reviewed.
46-
47-
30+
1. Fork this Repository.
31+
1. Select an issue or create an issue on which you want to work. Discuss with the maintainers.
32+
1. Before submitting a pull request, pleasecreate a seperate branch using `git checkout -b <name-of-the-new-branch>`
33+
1. To commit changes: `git commit -m "<a verbose message explaining which issue is being fixed by this commit>`
34+
1. To push the changes:`git push origin <your-branch-name>`
35+
1. Create a pull request on the repository wait for it to get reviewed.

0 commit comments

Comments
 (0)