diff --git a/README.md b/README.md index 2031018..cbae77a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,11 @@ A simple configurable API gateway for linking microservices to the Tulsa Web Dev Built in Rust and containerized with Docker. ## CONTRIBUTING -This is mostly a labor of love and learning that we might actually use. There are certainly existing solutions to this problem in the wild already. I'm building this in Rust🦀 to get better at my skills in that language and what I percieve as some of its strengths. I hope to learn more about performance optimization, telemetry/observability, and security. I'm happy to have friends on this journey who are in the mood to hack on it with me, just send me a message / make a draft PR if you have questions. I'm not going to write a lengthy contributing doc for this(yet)😅. +This is mostly a labor of love and learning that we might actually use. There are certainly existing solutions to this problem in the wild already. + +I'm building this in Rust🦀 to get better at my skills in that language and what I percieve as some of its strengths. I hope to learn more about performance optimization, telemetry/observability, and security. + +I'm happy to have friends on this journey who are in the mood to hack on it with me, just send me a message / make a draft PR if you have questions. I'm not going to write a lengthy contributing doc for this(yet)😅. ## ROADMAP ### MVP 0.x @@ -12,7 +16,9 @@ This is mostly a labor of love and learning that we might actually use. There ar - [ ] Containerize for development - [ ] Build Config mechanism - [ ] Build Simple Routing mechanism (JWT auth from front end, all just passed username / basic user metadata from Clerk.io, contents TBD) + *as time allows, build the Clerk interface to back pair of auth and metadata services so that the auth/metadata service is configurable* + - [ ] Containerize for deployment - [ ] Test - [ ] Deploy @@ -20,6 +26,7 @@ This is mostly a labor of love and learning that we might actually use. There ar ### Future Development #### High Priority - [ ] Add reverse proxy +- [ ] Add observability mechanisms (OpenTelemtry/tracing.rs ?) - [ ] Add auth bypass option for public APIs to config (Auth on by default) - [ ] Add read/write options to user metadata per service (nested under service name)