diff options
| -rw-r--r-- | README.md | 29 |
1 files changed, 17 insertions, 12 deletions
@@ -1,8 +1,8 @@ # Gus: The small web server toolkit -Gus is the toolkit for building small web servers in Go. +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. It's been said of gemini that you can write your server in a day. Now you can write it in under an hour. +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 @@ -17,7 +17,11 @@ The package contains: * helpers for building a gemini-suitable TLS config * a Server that can run your handler(s) -## contrib/ +## gus/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. + +## gus/contrib/* This is where useful building blocks themselves start to come in. Sub-packages of contrib include Handler and Middleware implementations which accomplish the things your servers actually need to do. @@ -29,24 +33,25 @@ So far there are at least 3 packages: ## Get it -=> [The code is hosted here on tildegit.](https://tildegit.org/tjp/gus) +### Using gus in your project -=> [The generated documentation is on the go package index.](https://pkg.go.dev/tildegit.org/tjp/gus) - -To add it to your go server project: +To add it to your own go project: ``` $ go get tildegit.org/tjp/gus ``` -## Contribute +### Straight to the code please -There's lots still to do, and contributions are very welcome! +* => [The code is hosted here on tildegit.](https://tildegit.org/tjp/gus) +* => [The generated documentation is on the go package index.](https://pkg.go.dev/tildegit.org/tjp/gus) -=> [submit an issue or pull request on the tildegit repository,](https://tildegit.org/tjp/gus) +## Contribute -=> [send me an email directly,](mailto:tjp@ctrl-c.club) +There's lots still to do, and contributions are very welcome! -or poke me on IRC: I'm @tjp on irc.tilde.chat, and you'll find me in #gemini +* => [submit an issue or pull request on the tildegit repository,](https://tildegit.org/tjp/gus) +* => [send me an email directly,](mailto:tjp@ctrl-c.club) +* or poke me on IRC: I'm @tjp on irc.tilde.chat, and you'll find me in #gemini ------------------------ |