Fix spelling errors and style in markdown files (9799618)

Fix spelling errors and style in markdown files

Hanno Böck commited on 2024-03-10 13:20:05
Zeige 3 geänderte Dateien mit 21 Einfügungen und 22 Löschungen.

CONTRIBUTIONS.md 19b9094..a05fb01
README.md d609164..74f1800
SECURITY.md cd922bc..2d67504

CONTRIBUTIONS.md

@@ -1,8 +1,8 @@
 contribute
 ==========
 
-If you want to contribute you can use pull requests and the issue tracker
-on our github mirror:
+If you want to contribute you can use pull requests and the issue tracker on our github
+mirror:
 
 https://github.com/schokokeksorg/freewvs/
 
@@ -13,15 +13,13 @@ If you prefer you can also contact us via e-mail:
 coding style
 ============
 
-Code should conform to the PEP8 coding standard. Furthermore we enable
-additional rules in pycodestyle and run some other linting tools
-(pylint, pyflakes, dlint).
+Code should conform to the PEP8 coding standard. Furthermore we enable additional rules
+in pycodestyle and run some other linting tools (pylint, pyflakes, dlint).
 
-The freewvsdb files should be linted JSON as created by json.dumps with
-2 spaces indenting.
+The freewvsdb files should be linted JSON as created by json.dumps with 2 spaces
+indenting.
 
-All code and JSON style requirements can be checked by running the unit
-tests:
+All code and JSON style requirements can be checked by running the unit tests:
 
 ```
 python -m unittest

README.md

Zeige Datei @ 9799618

@@ -2,21 +2,19 @@
 
 A local web vulnerability scanner.
 
-freewvs is a tool to search webroots for know vulnerable versions of web applications.
+freewvs is a tool to search webroots for known vulnerable versions of web applications.
 
 ## install
 
-Install
-
 You can install [freewvs via pip](https://pypi.org/project/freewvs/):
 
 ```
 pip install freewvs
 ```
 
-Alternatively you can run freewvs directly from the git source.
+Alternatively, you can run freewvs directly from the git source.
 
-If you install via pip you need to update the freewvs database first:
+If you install via pip, you need to update the freewvs database first:
 
 ```
 update-freewvsdb
@@ -46,22 +44,26 @@ It scans your webroot for known vulnerable versions of popular web applications.
 
 #### What does the output tell me?
 
-Output looks like this:
+The output looks like this:
 
 ```
 Joomla-3 3.9.11 (3.9.13) CVE-2019-18674 /home/joe/websites/joessite/
 ```
 
-This says that in /home/joe/websites/joessite/, there's a Joomla installation of version 3.9.11. This version is
-vulnerable to CVE-2019-18674 and you should update to version 3.9.13.
+This says that in /home/joe/websites/joessite/, there's a Joomla installation of version
+3.9.11. This version is vulnerable to CVE-2019-18674, and you should update it to
+version 3.9.13.
 
 #### CVE-2019-XXXX seems to be very minor, at least it doesn't affect me. Am I safe?
 
-No, as freewvs only checks for the latest vulnerabilities. There may be other vulnerabilities in your version not listed by freewvs. The only way to be sure is to check the upstream changelog.
+No, as freewvs only checks for the latest vulnerabilities. There may be other
+vulnerabilities in your version not listed by freewvs. The only way to be sure is to
+check the upstream changelog.
 
-#### There is no version inside the brackets, what does that mean?
+#### There is no version inside the brackets. What does that mean?
 
-It means your web application has not released a security update. Often this means the software is no longer developed.
+It means your web application has not released a security update. Often, this means the
+software is no longer developed.
 
 ## contributions
 

SECURITY.md

Zeige Datei @ 9799618

@@ -1,7 +1,6 @@
 security
 ========
 
-Please report security vulnerabilities via e-mail, you can optionally
-PGP-encrypt them:
+Please report security vulnerabilities via e-mail, you can optionally PGP-encrypt them:
 
 https://schokokeks.org/kontakt


...	...	@@ -1,8 +1,8 @@
1	1	contribute
2	2	==========
3	3
4		-If you want to contribute you can use pull requests and the issue tracker
5		-on our github mirror:
	4	+If you want to contribute you can use pull requests and the issue tracker on our github
	5	+mirror:
6	6
7	7	https://github.com/schokokeksorg/freewvs/
8	8
...	...	@@ -13,15 +13,13 @@ If you prefer you can also contact us via e-mail:
13	13	coding style
14	14	============
15	15
16		-Code should conform to the PEP8 coding standard. Furthermore we enable
17		-additional rules in pycodestyle and run some other linting tools
18		-(pylint, pyflakes, dlint).
	16	+Code should conform to the PEP8 coding standard. Furthermore we enable additional rules
	17	+in pycodestyle and run some other linting tools (pylint, pyflakes, dlint).
19	18
20		-The freewvsdb files should be linted JSON as created by json.dumps with
21		-2 spaces indenting.
	19	+The freewvsdb files should be linted JSON as created by json.dumps with 2 spaces
	20	+indenting.
22	21
23		-All code and JSON style requirements can be checked by running the unit
24		-tests:
	22	+All code and JSON style requirements can be checked by running the unit tests:
25	23
26	24	```
27	25	python -m unittest

...	...	@@ -2,21 +2,19 @@
2	2
3	3	A local web vulnerability scanner.
4	4
5		-freewvs is a tool to search webroots for know vulnerable versions of web applications.
	5	+freewvs is a tool to search webroots for known vulnerable versions of web applications.
6	6
7	7	## install
8	8
9		-Install
10		-
11	9	You can install [freewvs via pip](https://pypi.org/project/freewvs/):
12	10
13	11	```
14	12	pip install freewvs
15	13	```
16	14
17		-Alternatively you can run freewvs directly from the git source.
	15	+Alternatively, you can run freewvs directly from the git source.
18	16
19		-If you install via pip you need to update the freewvs database first:
	17	+If you install via pip, you need to update the freewvs database first:
20	18
21	19	```
22	20	update-freewvsdb
...	...	@@ -46,22 +44,26 @@ It scans your webroot for known vulnerable versions of popular web applications.
46	44
47	45	#### What does the output tell me?
48	46
49		-Output looks like this:
	47	+The output looks like this:
50	48
51	49	```
52	50	Joomla-3 3.9.11 (3.9.13) CVE-2019-18674 /home/joe/websites/joessite/
53	51	```
54	52
55		-This says that in /home/joe/websites/joessite/, there's a Joomla installation of version 3.9.11. This version is
56		-vulnerable to CVE-2019-18674 and you should update to version 3.9.13.
	53	+This says that in /home/joe/websites/joessite/, there's a Joomla installation of version
	54	+3.9.11. This version is vulnerable to CVE-2019-18674, and you should update it to
	55	+version 3.9.13.
57	56
58	57	#### CVE-2019-XXXX seems to be very minor, at least it doesn't affect me. Am I safe?
59	58
60		-No, as freewvs only checks for the latest vulnerabilities. There may be other vulnerabilities in your version not listed by freewvs. The only way to be sure is to check the upstream changelog.
	59	+No, as freewvs only checks for the latest vulnerabilities. There may be other
	60	+vulnerabilities in your version not listed by freewvs. The only way to be sure is to
	61	+check the upstream changelog.
61	62
62		-#### There is no version inside the brackets, what does that mean?
	63	+#### There is no version inside the brackets. What does that mean?
63	64
64		-It means your web application has not released a security update. Often this means the software is no longer developed.
	65	+It means your web application has not released a security update. Often, this means the
	66	+software is no longer developed.
65	67
66	68	## contributions
67	69

...	...	@@ -1,7 +1,6 @@
1	1	security
2	2	========
3	3
4		-Please report security vulnerabilities via e-mail, you can optionally
5		-PGP-encrypt them:
	4	+Please report security vulnerabilities via e-mail, you can optionally PGP-encrypt them:
6	5
7	6	https://schokokeks.org/kontakt
8	7

freewvs.git