aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Diego Bernardes <diego.bernardes@outlook.com> 2019-03-05 23:33:22 +0000
committerGravatar Abhinav Gupta <mail@abhinavg.net> 2019-03-05 15:33:22 -0800
commit76224eba02cfb97b18c724d69440b1fc999fccd6 (patch)
treec3d3140dcb40ebb197827df4a5132e32e918b9e1 /README.md
parente598b4a5dcbe7abf1815677cf0bf6a7983df7cc0 (diff)
downloadsally-76224eba02cfb97b18c724d69440b1fc999fccd6.tar.gz
sally-76224eba02cfb97b18c724d69440b1fc999fccd6.tar.zst
sally-76224eba02cfb97b18c724d69440b1fc999fccd6.zip
Support changing godoc instance (#38)
This adds the ability to change the godoc.org instance used by Sally to link to documentation by providing a new `godoc` section in the configuration.
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 51527ed..3046a78 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,11 @@ A tiny HTTP server for supporting custom Golang import paths
Create a YAML file with the following structure:
```yaml
+# This optional section configures godoc documentation linking.
+godoc:
+ # Instance of godoc.org used for documentation links. Defaults to godoc.org.
+ host: godoc.org
+
url: google.golang.org
packages:
grpc: