blob: 918ec194b47ce3c15fcd7c84c175f9d9e1fc9dfb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
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`.
|