update README.md
Iris Lightshard nilix@nilfm.cc
PGP Signature
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEkFh6dA+k/6CXFXU4O3+8IhROY5gFAmHdJdsACgkQO3+8IhRO Y5g1SQ/+NtIHhi8xayQz2DEE4l5v8h/xDL7dlXk77Hx9AiyV/lFWPBlKg44vZAuk UUxkXZKDuiocm9+a33qM5FmpT6u3hVBPvXauEqFUH2GjExy7kvkuANsE79N+xzDf W0UXqiamn6vo0LM1gdfF0+2biKINqPJdzCoFWmF4PbQLG0/mvr3AhCiVNJVGrXqF yGGJ6JDnBAsc2Io1ZECSUgH13mXU6CUSPtqzxhPh12PC1jKG7aUh53OJh9Jn5zSw 0PCj22qWe2bKHM577QwsIaIFxUYHTUM2GKGAhIKqzlkD92KzLl+NzPC+cIweoSf1 kgs152yBn528fZQNg0iezOIWu7eThw5v0wk8Ng8QToa0B6O8ld060tt19z5JFeSx mC5D8v2N6v7Fw3oHImysFzNjUZ+fH4sAW03/EU7+K+73E6nQplwmpaN0OvEGCN9x MIi2mtZsQP8+jxE+JYsVo7gh2UXPrDl/Jaqu1iKzcTX4lG6OcSxPkJ9/zEeoxhLl naE+HY/pSSMU4vbuxFvHN5BznMgm6eRH4QLFRGe+h/7UUshQr+Kp5qpSH0vcl4eC KsRTXVQDg6+STNGDknJ/RfxIGi5S3W62QuCONZs7jG6+NF6gTHHFsh9zjIcHJLkZ iZ3p4OVHdKJZjnoASEXGd/2e9NpVITLnEzGRjGB/y+HFTE6mv3E= =02Fj -----END PGP SIGNATURE-----
1 files changed,
5 insertions(+),
3 deletions(-)
jump to
M
README.md
→
README.md
@@ -14,14 +14,16 @@ The `auth` system is designed from scratch to provide a modular system where new authentication/authorization backends can be added easily by satisfying the `auth.UserStore` interface.
### about the name -The [Quartz Gun](https://eurekaseven.fandom.com/wiki/Quartz_Gun) is a weapon in the anime Eureka Seven AO; it's fueled by a sentient entity known as Quartz, and instead of being used in a traditional sense as a weapon, it alters the timeline when fired. Thinking about URL routes reminded me of the tree of light it emits when fired, so I named the library `quartzgun`. +Thinking about URL routes reminded me of the tree of light the fictional [Quartz Gun](https://eurekaseven.fandom.com/wiki/Quartz_Gun) emits when fired, so I named the library `quartzgun`. ## usage -A more complete usage guide will be forthcoming when the library is more complete, but for now you can check out the [quartzgun_test.go](https://nilfm.cc/git/quartzgun/tree/quartzgun_test.go) file for an overview of how to use it. +A more complete usage guide will be forthcoming, but for now you can check out the [quartzgun_test.go](https://nilfm.cc/git/quartzgun/tree/quartzgun_test.go) file for an overview of how to use it. ## roadmap/features +Features may be added here at any time as things are in early stages right now: + ### core functionality * [x] router (static service trees, paramaterized routes, and per-method handlers on routes)@@ -29,7 +31,7 @@ * [x] basic renderers (HTML template, JSON, XML)
### auth -* [ ] top-level wrapper for attaching `UserStore` backends to cookie handler +* [x] top-level wrapper for attaching `UserStore` backends to cookie handler * [x] POC [indental](https://wiki.xxiivv.com/site/indental.html) `UserStore` implementation ### etc