Skip to content

Commit 4cc118b

Browse files
Updated readme to include package versioning information.
1 parent 3824996 commit 4cc118b

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ONIXLabs Corda Core
44

5-
ONIXLabs Corda Core provides Corda developers with a suite of APIs to empower development of Corda contracts, workflows and integration. These APIs are not intended to be used as CorDapps, since they do not contain any states or contracts, however they are partitioned into contract, workflow and integration modules containing features to improve and simplify CorDapp design and development.
5+
The ONIXLabs Corda Core API provides Corda developers with a suite of APIs to empower development of Corda contracts, workflows and integration. These APIs are not intended to be used as CorDapps, since they do not contain any states or contracts, however they are partitioned into contract, workflow and integration modules containing features to improve and simplify CorDapp design and development.
66

77
## CorDapp Signing
88

@@ -47,6 +47,16 @@ Follow these steps to integrate the ONIXLabs Corda Core API into your applicatio
4747
}
4848
```
4949
50+
## Package Versioning
51+
52+
The ONIXLabs Corda Core API uses semantic versioning for every published release of the API. Version numbers apply the following format, **_major_._minor_._patch_**; for example 1.2.34
53+
54+
- **Major** - The API contains breaking changes which are not backwards compatible.
55+
- **Minor** - The API contains new features which are backwards compatible.
56+
- **Patch** - The API contains bug fixes which are backwards compatible.
57+
58+
Release Candidate versions are considered unstable and likely to change quickly. Release Candidate version numbers apply the following format, **_major_._minor_._patch_-rc#**; for example 1.2.0-rc3
59+
5060
5161
5262

0 commit comments

Comments
 (0)