summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--rust/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/rust/README.md b/rust/README.md
index 9242b599..d0480b87 100644
--- a/rust/README.md
+++ b/rust/README.md
@@ -1,6 +1,24 @@
Rust implementation of fatcat API server (`fatcatd`).
+## Status
+
+- HTTP API
+ - [ ] base32 encoding of UUID identifiers
+- SQL Schema
+ - [x] Basic entities
+ - [ ] one-to-many and many-to-many entities
+ - [ ] JSON(B) "extra" metadata fields
+- Web Interface
+ - [ ] Migrate Python codebase
+- Other
+ - [x] Basic logging
+ - [x] Swagger-UI
+ - [ ] Sentry (error reporting)
+ - [ ] Metrics
+ - [ ] Authentication (eg, accounts, OAuth2, JWT)
+ - [ ] Authorization (aka, roles)
+
## Development
- rust stable, 1.26+ (eg, via "rustup", includes cargo tool)