aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDerek Stevens <nilix@nilfm.cc>2022-01-10 23:38:19 -0700
committerDerek Stevens <nilix@nilfm.cc>2022-01-10 23:38:19 -0700
commit483e59e2b26f5797f99336bbe325411cf0dcaf77 (patch)
tree4016d23a7492e50efbf8eb0f3ab264bf5cff571b
parent26dcce986f2e9937d27d6a009d35e364eccf61d6 (diff)
update README.md
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 60633f4..934e28f 100644
--- a/README.md
+++ b/README.md
@@ -14,14 +14,16 @@ The `auth` system is designed from scratch to provide a modular system where new
### 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 @@ A more complete usage guide will be forthcoming when the library is more complet
### 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