Skip to content

Commit

Permalink
Update documentation on versioning of the javascript client releases
Browse files Browse the repository at this point in the history
Signed-off-by: Florian Fendt <Florian.Fendt@bosch-si.com>
  • Loading branch information
ffendt committed Oct 18, 2019
1 parent 8504d9f commit ef999fc
Showing 1 changed file with 7 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ More information can be found in the descriptions of the subpackages:
* [@eclipse-ditto/ditto-javascript-client-dom](https://github.com/eclipse/ditto-clients/blob/master/javascript/lib/dom/README.md)
* [@eclipse-ditto/ditto-javascript-client-node](https://github.com/eclipse/ditto-clients/blob/master/javascript/lib/node/README.md)

All released versions are published on [npmjs.com](https://www.npmjs.com/~eclipse_ditto).

## Compatibility with [Eclipse Ditto](https://github.com/eclipse/ditto)

The `@eclipse-ditto/ditto-javascript-client-<package>_<ditto-major-version>` modules
will be compatible with the `<ditto-major-version>`, so e.g. `@eclipse-ditto/ditto-javascript-client-<package>_1`
will be compatible with Eclipse Ditto 1.x. The javascript modules themselves use
The `@eclipse-ditto/ditto-javascript-client-<package>_<ditto-major.minor-version>` modules
will be compatible with the `<ditto-major.minor-version>`, so e.g. `@eclipse-ditto/ditto-javascript-client-<package>_1.0`
will be compatible with Eclipse Ditto 1.0.x. The javascript modules themselves use
[semantic versioning](https://docs.npmjs.com/about-semantic-versioning) for their
api changes. All modules are released together, so if there is a version
`@eclipse-ditto/ditto-javascript-client-api_0:1.0.1`, there's also a release
of `@eclipse-ditto/ditto-javascript-client-dom_0:1.0.1`.
`@eclipse-ditto/ditto-javascript-client-api_1.0:1.0.1`, there's also a release
of `@eclipse-ditto/ditto-javascript-client-dom_1.0:1.0.1`.

The newest release of the JavaScript client will always try to cover as much API
functionality of the same Eclipse Ditto major version as possible. There might
Expand Down

0 comments on commit ef999fc

Please sign in to comment.