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

doc: Update package documentation

Browse Source
This commit is contained in:
Adnan Maolood 2021-02-18 00:37:56 -05:00
parent aab3ac4dfe
commit a80aae44a9
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc.go
View File

@ -1,5 +1,5 @@
/*
Package gemini implements the Gemini protocol.
Package gemini provides Gemini client and server implementations.
Client is a Gemini client.
@ -25,17 +25,20 @@ Servers should be configured with certificates:
// handle error
}
Servers can accept requests for multiple hosts and schemes:
ServeMux is a Gemini request multiplexer.
ServeMux can handle requests for multiple hosts and schemes.
server.RegisterFunc("example.com", func(w gemini.ResponseWriter, r *gemini.Request) {
mux := &gemini.ServeMux{}
mux.HandleFunc("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")
mux.HandleFunc("example.org/about.gmi", func(w gemini.ResponseWriter, r *gemini.Request) {
fmt.Fprint(w, "About example.org")
})
server.RegisterFunc("http://example.net", func(w gemini.ResponseWriter, r *gemini.Request) {
mux.HandleFunc("http://example.net", func(w gemini.ResponseWriter, r *gemini.Request) {
fmt.Fprint(w, "Proxied content from http://example.net")
})
server.Handler = mux
To start the server, call ListenAndServe: