Skip to content

Commit 68e64dc

Browse files
FiloSottilerolandshoemaker
authored andcommitted
README: add provisional GCS bucket link
Change-Id: I6a8e08cb89341e33dba0c9cee94cc26e93a1ac59 Reviewed-on: https://team-review.git.corp.google.com/c/golang/vulndb/+/1061625 Reviewed-by: Roland Shoemaker <bracewell@google.com>
1 parent aca001a commit 68e64dc

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,21 @@ Read [the Draft Design](https://golang.org/design/draft-vulndb).
66
Neither the code, nor the data, nor the existence of this repository is to be
77
considered stable until an approved proposal.
88

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.
1224

1325
## Packages
1426

@@ -30,5 +42,6 @@ on in a more segmented fashion.
3042
Unless otherwise noted, the Go source files are distributed under
3143
the BSD-style license found in the LICENSE file.
3244

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
3447
[CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.

0 commit comments

Comments
 (0)