diff options
| author | Adnan Maolood <[email protected]> | 2020-11-09 12:07:49 -0500 |
|---|---|---|
| committer | Adnan Maolood <[email protected]> | 2020-11-09 12:07:49 -0500 |
| commit | f2a1510375475530c4bbf2293621b48a7baf7f02 (patch) | |
| tree | f77f4fa3389bfd6231f013fe4096d5af50f480e7 /doc.go | |
| parent | Remove top-level Get and Do functions (diff) | |
| download | go-gemini-f2a1510375475530c4bbf2293621b48a7baf7f02.tar.xz go-gemini-f2a1510375475530c4bbf2293621b48a7baf7f02.zip | |
Move documentation to gemini.go
Diffstat (limited to 'doc.go')
| -rw-r--r-- | doc.go | 50 |
1 files changed, 0 insertions, 50 deletions
@@ -1,50 +0,0 @@ -/* -Package gemini implements the Gemini protocol. - -Client is a Gemini client. - - client := &gemini.Client{} - resp, err := client.Get("gemini://example.com") - if err != nil { - // handle error - } - if resp.Status.Class() == gemini.StatusClassSucess { - defer resp.Body.Close() - // ... - } - // ... - -Server is a Gemini server. - - server := &gemini.Server{ - ReadTimeout: 10 * time.Second, - WriteTimeout: 10 * time.Second, - } - -Servers should be configured with certificates: - - err := server.Certificates.Load("/var/lib/gemini/certs") - if err != nil { - // handle error - } - -Servers can accept requests for multiple hosts and schemes: - - server.RegisterFunc("example.com", func(w *gemini.ResponseWriter, r *gemini.Request) { - fmt.Fprint(w, "Welcome to example.com") - }) - server.RegisterFunc("example.org", func(w *gemini.ResponseWriter, r *gemini.Request) { - fmt.Fprint(w, "Welcome to example.org") - }) - server.RegisterFunc("http://example.net", func(w *gemini.ResponseWriter, r *gemini.Request) { - fmt.Fprint(w, "Proxied content from http://example.net") - }) - -To start the server, call ListenAndServe: - - err := server.ListenAndServe() - if err != nil { - // handle error - } -*/ -package gemini |