nilix/quartzgun
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README.md

Browse source
This commit is contained in:
Iris Lightshard 2022-01-10 23:38:19 -07:00
parent 26dcce986f
commit 483e59e2b2
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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