@@ -6,9 +6,21 @@ Read [the Draft Design](https://golang.org/design/draft-vulndb).
6
6
Neither the code, nor the data, nor the existence of this repository is to be
7
7
considered stable until an approved proposal.
8
8
9
- ** Important** : vulnerability entries in this repository are represented in an
10
- internal, unstable format that can and will change without notice. The database
11
- will also be available in an interoperable, stable JSON format soon.
9
+ ** Important: vulnerability entries in this repository are represented in an
10
+ internal, unstable format that can and will change without notice.**
11
+
12
+ ## Consuming database entries
13
+
14
+ Database clients must not rely on the contents of this repository. Instead, they
15
+ can access the tree of JSON entries rooted at
16
+
17
+ https://storage.googleapis.com/go-vulndb/
18
+
19
+ An ` index.json ` file maps package names to last modified timestamps. For each
20
+ package name, a ` NAME.json ` file contains a list of vulnerability entries.
21
+
22
+ Note that this path and format are provisional and likely to change until an
23
+ approved proposal.
12
24
13
25
## Packages
14
26
@@ -30,5 +42,6 @@ on in a more segmented fashion.
30
42
Unless otherwise noted, the Go source files are distributed under
31
43
the BSD-style license found in the LICENSE file.
32
44
33
- The database contents in ` reports/ ` are distributed under the terms of the
45
+ Database entries available at https://storage.googleapis.com/go-vulndb/ are
46
+ distributed under the terms of the
34
47
[ CC-BY 4.0] ( https://creativecommons.org/licenses/by/4.0/ ) license.
0 commit comments