Skip to content

Commit 48fa057

Browse files
committed
Include Versioning Details in Readme
1 parent 4dd794e commit 48fa057

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

readme.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,12 @@ In the root directory:
9999
- MSSQL
100100
- PostgreSQL
101101
- Support Multi-schema diagrams (possibly using D2s multi-diagram options)
102-
- (Possibly) break out `d2` elements of the core package to enable other diagramming tools to be used
102+
- (Possibly) break out `d2` elements of the core package to enable other diagramming tools to be used
103+
104+
## Versioning
105+
106+
The project will be versioned with Semantic Versioning, as recommended by Github and Gitlab.
107+
108+
The Public API surface of this repo is the behaviour of the binary itself, as documented in this readme, and in the package documentation associated with that build.
109+
110+
Special consideration will be given to the interfaces in the `core` package, for those who may eventually use it as a basis in other tooling. These are currently subject to change as part of the intial development, but are intended to be included as part of the public API for version 1.

0 commit comments

Comments
 (0)