cmd: add documentation
Documentation about packages and commands is moved from README.md to a
package-level doc.
Change-Id: Iceb7e63673423f4b7ad1dc3364cb286f8b324206
Reviewed-on: https://go-review.googlesource.com/c/vuln/+/369476
Trust: Julie Qiu <julie@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
diff --git a/README.md b/README.md
index d5fb9fd..8a89c2b 100644
--- a/README.md
+++ b/README.md
@@ -43,16 +43,6 @@
Some of these packages can probably be coalesced, but for now are easier to work
on in a more segmented fashion.
-- `osv` provides a package for generating OSV-style JSON vulnerability entries
- from a `report.Report`
-- `client` contains a client for accessing HTTP/fs based vulnerability
- databases, as well as a minimal caching implementation
-- `cmd/dbdiff` provides a tool for comparing two different versions of the
- vulnerability database
-- `cmd/gendb` provides a tool for converting YAML reports into JSON database
-- `cmd/linter` provides a tool for linting individual reports
-- `cmd/report2cve` provides a tool for converting YAML reports into JSON CVEs
-
## License
Unless otherwise noted, the Go source files are distributed under
diff --git a/cmd/dbdiff/main.go b/cmd/dbdiff/main.go
index d5cc84f..98f16ed 100644
--- a/cmd/dbdiff/main.go
+++ b/cmd/dbdiff/main.go
@@ -2,6 +2,8 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+// Command dbdiff provides a tool for comparing two different versions of the
+// vulnerability database.
package main
import (
diff --git a/cmd/gendb/main.go b/cmd/gendb/main.go
index bc56e25..3bfad88 100644
--- a/cmd/gendb/main.go
+++ b/cmd/gendb/main.go
@@ -2,6 +2,8 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+// Command gendb provides a tool for converting YAML reports into JSON
+// database.
package main
import (
diff --git a/cmd/linter/main.go b/cmd/linter/main.go
index d3808d5..2c70d70 100644
--- a/cmd/linter/main.go
+++ b/cmd/linter/main.go
@@ -2,6 +2,7 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+// Command linter provides a tool for linting individual reports.
package main
import (
diff --git a/cmd/report2cve/main.go b/cmd/report2cve/main.go
index 42a7a59..e5729b9 100644
--- a/cmd/report2cve/main.go
+++ b/cmd/report2cve/main.go
@@ -2,6 +2,8 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+// Command report2cve provides a tool for converting YAML reports into JSON
+// CVEs.
package main
import (
