Merge pull request #7 from onix-labs/main

Main

Author: MrMatthewLayton

.idea/runConfigurations/Run_Contract_Tests.xml

@@ -1,15 +1,13 @@
-/**
- * Copyright 2020 Matthew Layton
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+Copyright 2020-2021 ONIXLabs
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

.idea/runConfigurations/Run_Workflow_Tests.xml

@@ -2,11 +2,57 @@
 
 # ONIXLabs Corda Core
 
-ONIXLabs Corda Core provides Corda developers with a suite of APIs to empower development of CorDapps, and also serves as the foundation for all of the ONIXLabs Corda Frameworks and APIs.
+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.
 
-Whilst the ONIXLabs Corda Core API isn't intended to be used as a CorDapp (it doesn't have any of it's own states and/or contracts), it's partitioned into contract, workflow and integration layers for simplicty, and is signed with the ONIXLabs key.
+## CorDapp Signing
 
+As of version 2.0.0 of the ONIXLabs Corda Core API, this repository ships with the ONIXLabs developer signing key so that this repository can be checked out and built locally. Official releases of this API are signed with the ONIXLabs production signing key.
 
+## Integration Guide
 
+Follow these steps to integrate the ONIXLabs Corda Core API into your application
 
+1.  Add the following to your project's top level **build.gradle** file.
 
+    ```
+    buildscript {
+        ext {
+            onixlabs_group = 'io.onixlabs'
+            onixlabs_corda_core_release_version = '2.0.0'
+        }
+    }
+    ```
+
+2.  Implement the ONIXLabs Corda Core contract module into your contract.
+
+    ```
+    dependencies {
+        cordapp "$onixlabs_group:onixlabs-corda-core-contract:$onixlabs_corda_core_release_version"
+    }
+    ```
+
+3.  Implement the ONIXLabs Corda Core workflow module into your workflow.
+
+    ```
+    dependencies {
+        cordapp "$onixlabs_group:onixlabs-corda-core-workflow:$onixlabs_corda_core_release_version"
+    }
+    ```
+
+4.  Implement the ONIXLabs Corda Core integration module into your integration.
+
+    ```
+    dependencies {
+        implementation "$onixlabs_group:onixlabs-corda-core-integration:$onixlabs_corda_core_release_version"
+    }
+    ```
+
+## Package Versioning
+
+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
+
+-   **Major** - The API contains breaking changes which are not backwards compatible.
+-   **Minor** - The API contains new features which are backwards compatible.
+-   **Patch** - The API contains bug fixes which are backwards compatible.
+
+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

CHANGELOG.md

@@ -23,8 +23,8 @@ buildscript {
         cordapp_signing_enabled = true
         cordapp_signing_alias = 'cordapp-signer'
         cordapp_signing_storetype = 'PKCS12'
-        cordapp_signing_keystore = getProperty('jar.sign.keystore')
-        cordapp_signing_password = getProperty('jar.sign.password')
+        cordapp_signing_keystore = findProperty('onixlabs.production.jarsign.keystore') ?: getProperty('onixlabs.development.jarsign.keystore')
+        cordapp_signing_password = findProperty('onixlabs.production.jarsign.password') ?: getProperty('onixlabs.development.jarsign.password')
     }
 
     repositories {
@@ -42,7 +42,7 @@ buildscript {
 }
 
 group 'io.onixlabs'
-version '1.2.0'
+version '2.0.0'
 
 subprojects {
     repositories {