summaryrefslogtreecommitdiff
path: root/README.gmi
diff options
context:
space:
mode:
authortjpcc <tjp@ctrl-c.club>2023-05-01 08:18:12 -0600
committertjpcc <tjp@ctrl-c.club>2023-05-01 08:18:12 -0600
commita97480d593dfc9ec1121d65b1697b53750f0d979 (patch)
tree542d3fe933850527fadc43239b58fc5ada42c472 /README.gmi
parent4777ea6d080881eedb2064e395cc6760ae2190f4 (diff)
more README updates
- lowercase the name everywhere - include a link back to gus
Diffstat (limited to 'README.gmi')
-rw-r--r--README.gmi13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.gmi b/README.gmi
index 571e605..33fa1a4 100644
--- a/README.gmi
+++ b/README.gmi
@@ -1,16 +1,16 @@
# sliderule: The small web toolkit for Go
-Sliderule is the toolkit for working with the small web in Go.
+sliderule 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 well under an hour.
## The slide rule
-Sliderule is named after the iconic instrument used to perform approximate mathematical calculations before the advent of handheld electronic calculators. It was the predominant tool that identified an engineer during project Gemini, a sort of developer's tool of it's time.
+sliderule is named after the iconic instrument used to perform approximate mathematical calculations before the advent of handheld electronic calculators. It was the predominant tool that identified an engineer during project Gemini, a sort of developer's tool of it's time.
## The "sliderule" package
-Sliderule is carefully structured as composable building blocks. The top-level package defines the framework in which servers and clients can be built.
+sliderule is carefully structured as composable building blocks. The top-level package defines the framework in which servers and clients can be built.
* a request type
* a response type
@@ -34,7 +34,7 @@ The primary text formats for those protocols have higher-level support provided
## Logging
-Sliderule borrows the logging interface from go-kit.
+sliderule borrows the logging interface from go-kit.
=> https://pkg.go.dev/github.com/go-kit/log#Logger The logger interface from go-kit/log.
@@ -84,6 +84,11 @@ Since v0.9.0, releases are signed with minisign. The signature file is included
=> gemini://gemini.ctrl-c.club/~tjp TJP's home page, which also mentions the public key used for signing sliderule releases.
+## Previously
+
+This project used to be called "gus", and the original project's old issues can be found at:
+=> https://tildegit.org/tjp/gus
+
## Contribute
There's lots still to do, and contributions are very welcome!