diff options
Diffstat (limited to 'README.gmi')
| -rw-r--r-- | README.gmi | 23 |
1 files changed, 16 insertions, 7 deletions
@@ -4,22 +4,31 @@ Gus is the toolkit for working with the small web in Go. Think of it as a net/http for small web protocols. You still have to write your server, but you can focus on the logic you want to implement knowing the protocol is already dealt with. It's been said of gemini that you can write your server in a day. Now you can write it in under an hour. -## gus/gemini +## The "gus" package -Gus is determined to be structured as composable building blocks, and the gemini package mainly just defines the structure that holds the blocks together. +Gus is carefully structured as composable building blocks. The top-level package defines the framework in which servers and clients can be built. -The package contains: * a request type * a response type +* a "Server" interface type * a "Handler" abstraction * a "Middleware" abstraction * some useful Handler wrappers: filtering, falling through a list of handlers -* helpers for building a gemini-suitable TLS config -* a Server that can run your handler(s) -## gus/gemtext +## gus/gemini + +Gus is determined to be structured as composable building blocks, and the gemini package mainly just defines the structure that holds the blocks together. + +The gemini package provides some gemini-specific concrete implementations. +* I/O (parsing, formatting) request and responses for the gemini protocol +* constructors for the various kinds of gemini protocol responses +* a helper for building a gemini-suitable TLS config +* a Client implementation +* a Server which can run your Handlers. + +## gus/gemini/gemtext -The gemtext package today provides a parser for gemtext documents. In the future, there will be conversions for the in-memory parsed representation into markdown, html, and whatever else people come up with. +The gemtext package provides a parser and converters for gemtext documents. It exposes an AST representation for parsed gemtext, and functions to write that AST out as other formats (currently markdown and HTML are supported, but more are planned). ## gus/contrib/* |