diff options
| author | tjpcc <tjp@ctrl-c.club> | 2023-09-01 12:41:52 -0600 |
|---|---|---|
| committer | tjpcc <tjp@ctrl-c.club> | 2023-09-01 12:41:52 -0600 |
| commit | a918c9d02d8558e612be84daac3c28204bb0f93f (patch) | |
| tree | abc475556050fdf326eec6de5ef4cc991e5b5c5e | |
| parent | a61bcdeb314d4e0e9f6e8915b92010895170e785 (diff) | |
README updates
| -rw-r--r-- | README.gmi | 4 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 7 insertions, 3 deletions
@@ -44,9 +44,11 @@ The packages sliderule/gemini, sliderule/gopher, sliderule/finger, and sliderule * Servers which can run your Handlers. The primary text formats for those protocols have higher-level support provided in sub-packages: -* sliderule/gemini/gemtext supports parsing gemtext and getting direct programmatic access to its AST. Deeper sub-packages provide converters to other formats (markdown and HTML) with overridable templates. +* sliderule/gemini/gemtext supports parsing gemtext and getting direct programmatic access to its AST. * sliderule/gopher/gophermap similarly parses the gophermap format and provides access to its AST. +Sub-packages in the text formats provide conversion functions to HTML, markdown, and Atom XML, using overridable templates. + ## Logging sliderule borrows the logging interface from go-kit. @@ -32,7 +32,7 @@ sliderule is carefully structured as composable building blocks. The top-level p * a "Server" interface type * a "Handler" abstraction * a "Middleware" abstraction -* a "Client" which handles all the protocols known to sliderule +* a "Client" implementation which wraps multiple protocol-specific clients and can handle URLs with a variety of schemes * some useful Handler wrappers: a router, request filtering, falling through a list of handlers ## Protocols @@ -47,9 +47,11 @@ The packages sliderule/gemini, sliderule/gopher, sliderule/finger, and sliderule The primary text formats for those protocols have higher-level support provided in sub-packages: -* sliderule/gemini/gemtext supports parsing gemtext and getting direct programmatic access to its AST. Deeper sub-packages provide converters to other formats (markdown and HTML) with overridable templates. +* sliderule/gemini/gemtext supports parsing gemtext and getting direct programmatic access to its AST. * sliderule/gopher/gophermap similarly parses the gophermap format and provides access to its AST. +Sub-packages in the text formats provide conversion functions to HTML, markdown, and Atom XML, using overridable templates. + ## Logging sliderule borrows the logging interface from go-kit. |