aboutsummaryrefslogtreecommitdiff
path: root/doc.go
blob: ea988ef14a4880a4d96ec31e7f88f21440106df9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
Package gemini implements the Gemini protocol.

Get makes a Gemini request:

	resp, err := gemini.Get("gemini://example.com")
	if err != nil {
		// handle error
	}
	if resp.Status.Class() == gemini.StatusClassSucess {
		defer resp.Body.Close()
		// ...
	}
	// ...

For control over client behavior, create a Client:

	client := &gemini.Client{}
	resp, err := client.Get("gemini://example.com")
	if err != nil {
		// handle error
	}
	// ...

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