From 922c0b7fd60aa05c5dfcfffd5840f0a2c0c9b453 Mon Sep 17 00:00:00 2001 From: Ulas Date: Thu, 2 Apr 2026 14:19:56 +0200 Subject: [PATCH] chore: add .nvmrc and README sections for API docs and roadmap - Add .nvmrc (22) for nvm/fnm users - README: add API section pointing to SPEC.md and server/routes/ - README: add Roadmap section linking to BACKLOG.md Co-Authored-By: Claude Sonnet 4.6 --- .nvmrc | 1 + README.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 .nvmrc diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..2bd5a0a --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +22 diff --git a/README.md b/README.md index d359a57..8923202 100644 --- a/README.md +++ b/README.md @@ -513,6 +513,18 @@ Only admins can create accounts — there is no public registration. --- +## 📡 API + +All endpoints live under `/api/v1/` and require session authentication (except login). Each route file in `server/routes/` corresponds to one module. Responses follow a consistent format: `{ data: ... }` on success, `{ error: string, code: number }` on failure. See [`docs/SPEC.md`](docs/SPEC.md) for the data model and [`server/routes/`](server/routes/) for endpoint details. + +--- + +## 🗺 Roadmap + +See [`BACKLOG.md`](BACKLOG.md) for planned features and ideas. Got a suggestion? [Open a feature request](https://github.com/ulsklyc/oikos/issues/new?template=feature_request.md). + +--- + ## 🤝 Contributing Contributions are welcome! If you find a bug or have a feature idea, [open an issue](https://github.com/ulsklyc/oikos/issues). Pull requests are appreciated — please keep the vanilla JS constraint in mind (no frameworks, no build tools).