sashakoshka/go-gemini
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Adnan Maolood 2021-02-23 14:29:37 -05:00
parent d8b5fa716a
commit eee7156b3a
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc.go
View File

@ -4,7 +4,8 @@ Package gemini provides Gemini client and server implementations.
Client is a Gemini client. Client is a Gemini client.
client := &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 { if err != nil {
// handle error // handle error
} }
@ -21,11 +22,12 @@ Server is a Gemini server.
Servers should be configured with certificates: Servers should be configured with certificates:
certificates := &certificate.Store{} certificates := &certificate.Store{}
certificates.Register("localhost")
err := certificates.Load("/var/lib/gemini/certs") err := certificates.Load("/var/lib/gemini/certs")
if err != nil { if err != nil {
// handle error // handle error
} }
server.GetCertificate = certificates.GetCertificate server.GetCertificate = certificates.Get
ServeMux is a Gemini request multiplexer. ServeMux is a Gemini request multiplexer.
ServeMux can handle requests for multiple hosts and schemes. 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: To start the server, call ListenAndServe:
err := server.ListenAndServe(context.Background()) ctx := context.Background()
err := server.ListenAndServe(ctx)
if err != nil { if err != nil {
// handle error // handle error
} }