diff options
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`. |