diff options
| author | xengineering <me@xengineering.eu> | 2025-07-24 14:37:21 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2025-07-24 14:46:00 +0200 |
| commit | 1a44c30c94dbbf0f3aabc1610d61b032d9d80e29 (patch) | |
| tree | 768218ad4d106fdf29192319cf4fc7a4159f7edd /doc/api/README.md | |
| parent | de80791503ceb080c8b32330e0414bf099e40ab0 (diff) | |
| download | iot-contact-1a44c30c94dbbf0f3aabc1610d61b032d9d80e29.tar iot-contact-1a44c30c94dbbf0f3aabc1610d61b032d9d80e29.tar.zst iot-contact-1a44c30c94dbbf0f3aabc1610d61b032d9d80e29.zip | |
doc: api: Add README.md and flatten future.md structure
This makes it later possible to diff the planned `current.md` with the
`future.md`. When the firmware is feature-complete the diff should be
empty.
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md new file mode 100644 index 0000000..918ec19 --- /dev/null +++ b/doc/api/README.md @@ -0,0 +1,13 @@ +# API specification + +This folder contains the API specification as required by semantic versioning. + +Currently only the `future.md` file is given. This is the long term goal how +the API should look like at the time of writing / committing. + +This will be extended by a `current.md` file describing the current state using +the same structure. This version has to match always with the implementation in +every commit. + +By this approach it will be possible to see what is left to implement by +running `diff current.md future.md`. |