diff --git a/README.md b/README.md index 57f862e..ec2e7c0 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ - [Overview](#overview) - [API](#api) +- [Versioning](#versioning) - [Contribute](#contribute) - [License](#license) @@ -99,6 +100,20 @@ NOTE: the object returned from the initial setup call to the exchanger returns t At the moment, the [Leaner Credential Wallet](https://lcw.app) only supports the directDeepLink. +## Versioning + +The transaction-service is primarily intended to run as a docker image within a docker compose network, typically as part of a flow that is orchestrated by the [DCC Issuer Coordinator](https://github.com/digitalcredentials/issuer-coordinator) and the [DCC Workflow Coordinator](https://github.com/digitalcredentials/workflow-coordinator). + +For convenience we've published the images for the transaction-service and the other services used by the coordinators, as well as for the coordinators themselves, to Docker Hub so that you don't have to build them locally yourself from the github repositories. + +The images on Docker Hub will of course at times be updated to add new functionality and fix bugs. Rather than overwrite the default (`latest`) version on Docker Hub for each update, we've adopted the [Semantic Versioning Guidelines](https://semver.org) with our docker image tags. + +We DO NOT provide a `latest` tag so you must provide a tag name (i.e, the version number) for the images in your docker compose file. + +To ensure you've got compatible versions of the services and the coordinator, the `major` number for each should match. At the time of writing, the versions for each are at 0.1.0, and the `major` number (the leftmost number) agrees across all three. + +If you do ever want to work from the source code in the repository and build your own images, we've tagged the commits in Github that were used to build the corresponding Docker image. So a github tag of v0.1.0 coresponds to a docker image tag of 0.1.0 + ## Development To install locally (for development):