aboutsummaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorAdnan Maolood <[email protected]>2021-02-23 14:29:37 -0500
committerAdnan Maolood <[email protected]>2021-02-23 14:29:37 -0500
commiteee7156b3a942b36cc4711d3c9c017d51d431d11 (patch)
tree9f1545f911ba88b9101ad5853bb97757b93972e5 /doc.go
parentclient: Use present tense in documentation (diff)
downloadgo-gemini-eee7156b3a942b36cc4711d3c9c017d51d431d11.tar.xz
go-gemini-eee7156b3a942b36cc4711d3c9c017d51d431d11.zip
Update documentation
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc.go b/doc.go
index 9d60ead..227180a 100644
--- a/doc.go
+++ b/doc.go
@@ -4,7 +4,8 @@ Package gemini provides Gemini client and server implementations.
Client is a Gemini client.
client := &gemini.Client{}
- resp, err := client.Get("gemini://example.com")
+ ctx := context.Background()
+ resp, err := client.Get(ctx, "gemini://example.com")
if err != nil {
// handle error
}
@@ -21,11 +22,12 @@ Server is a Gemini server.
Servers should be configured with certificates:
certificates := &certificate.Store{}
+ certificates.Register("localhost")
err := certificates.Load("/var/lib/gemini/certs")
if err != nil {
// handle error
}
- server.GetCertificate = certificates.GetCertificate
+ server.GetCertificate = certificates.Get
ServeMux is a Gemini request multiplexer.
ServeMux can handle requests for multiple hosts and schemes.
@@ -44,7 +46,8 @@ ServeMux can handle requests for multiple hosts and schemes.
To start the server, call ListenAndServe:
- err := server.ListenAndServe(context.Background())
+ ctx := context.Background()
+ err := server.ListenAndServe(ctx)
if err != nil {
// handle error
}