Skip to content

Commit a66075e

Browse files
committed
Remove old screenshot from README
Signed-off-by: Keshav Priyadarshi <[email protected]>
1 parent 332169c commit a66075e

File tree

3 files changed

+28
-32
lines changed

3 files changed

+28
-32
lines changed

README.rst

Lines changed: 28 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ we are trying to change this and evolve the status quo in a few other areas!
3838

3939
Package URL themselves were designed first in ScanCode and VulnerableCode
4040
and are now a de-facto standard for vulnerability management and package references.
41-
4241
See https://github.com/package-url/purl-spec
4342

4443
The VulnerableCode project is a FOSS community resource to help improve the
@@ -47,34 +46,39 @@ security of the open source software ecosystem and its users at large.
4746
VulnerableCode consists of a database and the tools to collect, refine and keep
4847
the database current.
4948

50-
.. warning::
51-
VulnerableCode is under active development and is not yet fully
52-
usable.
5349

54-
Read more about VulnerableCode https://vulnerablecode.readthedocs.org/
50+
.. pull-quote::
51+
**Warning**
52+
53+
VulnerableCode is under active development and is not yet fully
54+
usable.
5555

56-
VulnerableCode is financially supported by NLnet, nexB, Google (through the
57-
GSoC) and the active contributions of several volunteers.
56+
57+
Read more about VulnerableCode https://vulnerablecode.readthedocs.org/
5858

5959
VulnerableCode tech stack is Python, Django, PostgreSQL, nginx and Docker and
6060
several libraries.
6161

6262

6363
Getting started
64-
---------------
64+
===============
6565

6666
Run with Docker
67-
^^^^^^^^^^^^^^^^
67+
---------------
68+
69+
First install docker, then run
6870

69-
First install docker, then run::
71+
.. code:: bash
7072
7173
git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode
7274
make envfile
7375
docker compose build
7476
docker compose up -d
7577
docker compose run vulnerablecode ./manage.py import --list
7678
77-
Then run an importer for nginx advisories (which is small)::
79+
Then run an importer for nginx advisories (which is small)
80+
81+
.. code:: bash
7882
7983
docker compose exec vulnerablecode ./manage.py import vulnerabilities.importers.nginx.NginxImporter
8084
docker compose exec vulnerablecode ./manage.py improve --all
@@ -84,22 +88,29 @@ some data at http://localhost
8488

8589

8690
Populate VulnerableCode database
87-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
91+
--------------------------------
8892

8993
VulnerableCode data collection works in two steps: importing data from multiple
9094
sources and then refining and improving how package and software vulnerabilities
9195
are related.
9296

93-
To run all importers and improvers use this::
97+
To run all importers and improvers use this
98+
99+
.. code:: bash
94100
95101
./manage.py import --all
102+
103+
.. code:: bash
104+
96105
./manage.py improve --all
97106
98107
99108
Local development installation
100-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
109+
------------------------------
110+
111+
On a Debian system, use this
101112

102-
On a Debian system, use this::
113+
.. code:: bash
103114
104115
sudo apt-get install python3-venv python3-dev postgresql libpq-dev build-essential
105116
git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode
@@ -112,22 +123,9 @@ On a Debian system, use this::
112123
113124
At this point, the VulnerableCode app and API is up at http://127.0.0.1:8001/
114125

115-
Interface
116-
^^^^^^^^^^
117-
118-
119-
VulnerableCode comes with a minimal web UI:
120-
121-
.. image:: vulnerablecode-ui.png
122-
123-
And a JSON API and its minimal web documentation:
124-
125-
.. image:: vulnerablecode-json-api.png
126-
.. image:: vulnerablecode-api-doc.png
127-
128126

129127
License
130-
^^^^^^^^^^
128+
========
131129

132130
Copyright (c) nexB Inc. and others. All rights reserved.
133131

@@ -149,7 +147,7 @@ See https://aboutcode.org for more information about nexB OSS projects.
149147

150148

151149
Acknowledgements, Funding, Support and Sponsoring
152-
--------------------------------------------------------
150+
=================================================
153151

154152
This project is funded, supported and sponsored by:
155153

@@ -281,5 +279,3 @@ Communications Networks, Content and Technology under grant agreement No 1010695
281279
:target: https://nlnet.nl/discovery/
282280
:height: 40
283281
:alt: NGI Discovery logo
284-
285-

vulnerablecode-json-api.png

-87.3 KB
Binary file not shown.

vulnerablecode-ui.png

-138 KB
Binary file not shown.

0 commit comments

Comments
 (0)