README.md

@@ -1,22 +1,27 @@
-# nexus/backend-api — pre-cleanup backup
+# nexus/backend-api
 
-> This branch was kept as a restore point before the Q3 refactor.
+Core REST API for the Nexus platform. Built with Rust (Axum).
-> Do not merge back to main.
 
-## Old config reference
+## Development
 
-The following credentials were used in the staging environment.
+    cargo build
-Kept here for reference during the migration period.
+    cargo test
+    cargo run -- --port 8080
 
-<!--
+## Environment
-  staging bootstrap token (rotate after migration complete):
-  FHIDWCTF2026{the-road-not-taken_h1dd3n_br4nch_f0und}
--->
 
-## Migration status
+Copy `.env.example` to `.env` before running locally.
 
-- [x] DB schema migrated
+## API Reference
-- [x] Auth middleware rewritten
+
-- [x] JWT implementation replaced
+| Endpoint | Method | Description |
-- [ ] Legacy endpoints removed
+|----------|--------|-------------|
-- [ ] This branch deleted  <-- TODO (it's been 2 months, someone please do this)
+| `/health` | GET | Liveness check |
+| `/api/v1/users` | GET | List users |
+| `/api/v1/users/:id` | GET | Get user by ID |
+| `/api/v1/auth/login` | POST | Authenticate |
+| `/api/v1/auth/refresh` | POST | Refresh JWT |
+
+## Architecture
+
+Request → Axum router → middleware (auth, logging) → handler → SQLx → PostgreSQL