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:
adnano 2020-10-12 16:49:35 -04:00
parent e75d028c05
commit cbeb45ff0a
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc.go
View File

@ -4,10 +4,11 @@ Package gmi implements the Gemini protocol.
Send makes a Gemini request: Send makes a Gemini request:
req := gmi.NewRequest("gemini://example.com") req := gmi.NewRequest("gemini://example.com")
err := gmi.Send(req) resp, err := gmi.Send(req)
if err != nil { if err != nil {
// handle error // handle error
} }
// ...
For control over client behavior, create a Client: For control over client behavior, create a Client:
@ -31,7 +32,7 @@ Clients can control when to trust certificates with TrustCertificate:
return knownHosts.Lookup(hostname, cert) return knownHosts.Lookup(hostname, cert)
} }
If a server responds with StatusCertificateRequired, the default client will generate a certificate and resend the request with it. Custom clients can specify GetCertificate: If a server responds with StatusCertificateRequired, the default client will generate a certificate and resend the request with it. Custom clients can do so in GetCertificate:
client.GetCertificate = func(hostname string, store *gmi.CertificateStore) *tls.Certificate { client.GetCertificate = func(hostname string, store *gmi.CertificateStore) *tls.Certificate {
// If the certificate is in the store, return it // If the certificate is in the store, return it