aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 21f76e1..030bfde 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,18 @@ packages:
#
# Defaults to the value of the top-level url field.
url: example.com
+
+ # Optional URL to the package's documentation.
+ #
+ # Defaults to the documentation site at pkg.go.dev with the package's
+ # module path appended.
+ doc_url: example.com/go-pkg/docs/zap
+
+ # Optional URL to the badge image which appears in the index page.
+ #
+ # Defaults to the badge image at pkg.go.dev, using the package's module
+ # path followed by .svg as the filename.
+ doc_badge: example.com/go-pkg/badge/zap
```
Run sally like so: