Skip to content

Commit e402bdc

Browse files
Updated readme
1 parent 670a906 commit e402bdc

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,50 @@
22

33
# ONIXLabs Corda Core
44

5-
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.
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.
66

7-
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.
7+
## CorDapp Signing
8+
9+
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.
10+
11+
## Integration Guide
12+
13+
Follow these steps to integrate the ONIXLabs Corda Core API into your application
14+
15+
1. Add the following to your project's top level **build.gradle** file.
16+
17+
```
18+
buildscript {
19+
ext {
20+
onixlabs_group = 'io.onixlabs'
21+
onixlabs_corda_core_release_version = '2.0.0'
22+
}
23+
}
24+
```
25+
26+
2. Implement the ONIXLabs Corda Core contract module into your contract.
27+
28+
```
29+
dependencies {
30+
cordapp "$onixlabs_group:onixlabs-corda-core-contract:$onixlabs_corda_core_release_version"
31+
}
32+
```
33+
34+
3. Implement the ONIXLabs Corda Core workflow module into your workflow.
35+
36+
```
37+
dependencies {
38+
cordapp "$onixlabs_group:onixlabs-corda-core-workflow:$onixlabs_corda_core_release_version"
39+
}
40+
```
41+
42+
4. Implement the ONIXLabs Corda Core integration module into your integration.
43+
44+
```
45+
dependencies {
46+
implementation "$onixlabs_group:onixlabs-corda-core-integration:$onixlabs_corda_core_release_version"
47+
}
48+
```
849
950
1051

0 commit comments

Comments
 (0)