Skip to content

Commit 624db21

Browse files
authored
Update README.rst
Editorial improvements
1 parent 96a52e8 commit 624db21

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.rst

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ VulnerableCode
1919

2020

2121
VulnerableCode is a free and open database of open source software package
22-
vulnerabilities **because open source software vulnerabilities data and tools
22+
vulnerabilities **because open source software vulnerability data and tools
2323
should be free and open source themselves**:
2424

25-
we are trying to change this and evolve the status quo in a few other areas!
25+
We are trying to change this and evolve the status quo in a few other areas!
2626

2727
- Vulnerability databases have been **traditionally proprietary** even though they
2828
are mostly about free and open source software.
@@ -31,13 +31,13 @@ we are trying to change this and evolve the status quo in a few other areas!
3131
means a lot of false positive signals that require extensive expert reviews.
3232

3333
- Vulnerability databases are also mostly about vulnerabilities first and software
34-
package second, making it difficult to find if and when a vulnerability applies
35-
to a piece of code. VulnerableCode focus is on software package first where
36-
a Package URL is a key and natural identifier for packages; this is making it
34+
packages second, making it difficult to find if and when a vulnerability applies
35+
to a piece of code. VulnerableCode's focus is on software packages first where
36+
a Package URL (PURL) is a key and natural identifier for packages; this makes it
3737
easier to find a package and whether it is vulnerable.
3838

39-
Package URL themselves were designed first in ScanCode and VulnerableCode
40-
and are now a de-facto standard for vulnerability management and package references.
39+
PURLs were designed initially for ScanCode and VulnerableCode. PURL is
40+
now a de-facto standard for vulnerability management and package references.
4141
See https://github.com/package-url/purl-spec
4242

4343
The VulnerableCode project is a FOSS community resource to help improve the
@@ -49,17 +49,14 @@ the database current.
4949

5050
.. pull-quote::
5151
**Warning**
52+
VulnerableCode is under active development and may not be ready for production
53+
use depending on your use cases.
5254

53-
VulnerableCode is under active development and is not yet fully
54-
usable.
55+
Read more about VulnerableCode at https://vulnerablecode.readthedocs.org/
5556

56-
57-
Read more about VulnerableCode https://vulnerablecode.readthedocs.org/
58-
59-
VulnerableCode tech stack is Python, Django, PostgreSQL, nginx and Docker and
57+
The VulnerableCode tech stack is Python, Django, PostgreSQL, nginx and Docker and
6058
several libraries.
6159

62-
6360
Getting started
6461
===============
6562

0 commit comments

Comments
 (0)