aboutsummaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authoradnano <[email protected]>2020-10-12 16:56:26 -0400
committeradnano <[email protected]>2020-10-12 16:56:55 -0400
commit4770ad9112ef9d9bf2c3140c68aedcee61adf657 (patch)
treec7d3cada3dfdce17a7ab123622fb0f10c4d10f1d /doc.go
parentUpdate documentation (diff)
downloadgo-gemini-4770ad9112ef9d9bf2c3140c68aedcee61adf657.tar.xz
go-gemini-4770ad9112ef9d9bf2c3140c68aedcee61adf657.zip
Rename (*KnownHosts).Load to LoadDefault
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc.go b/doc.go
index 98e4fcf..424a3c1 100644
--- a/doc.go
+++ b/doc.go
@@ -1,7 +1,7 @@
/*
Package gmi implements the Gemini protocol.
-Send makes a Gemini request:
+Send makes a Gemini request with the default client:
req := gmi.NewRequest("gemini://example.com")
resp, err := gmi.Send(req)
@@ -10,18 +10,19 @@ Send makes a Gemini request:
}
// ...
-For control over client behavior, create a Client:
+For control over client behavior, create a custom Client:
var client gmi.Client
- err := client.Send(req)
+ resp, err := client.Send(req)
if err != nil {
// handle error
}
+ // ...
The default client loads known hosts from "$XDG_DATA_HOME/gemini/known_hosts".
Custom clients can load their own list of known hosts:
- err := client.KnownHosts.LoadFrom("path/to/my/known_hosts")
+ err := client.KnownHosts.Load("path/to/my/known_hosts")
if err != nil {
// handle error
}
@@ -56,7 +57,10 @@ Server is a Gemini server.
Servers must be configured with certificates:
- server.CertificateStore.Load("/var/lib/gemini/certs")
+ err := server.CertificateStore.Load("/var/lib/gemini/certs")
+ if err != nil {
+ // handle error
+ }
Servers can accept requests for multiple hosts and schemes: