Improve readme
This commit is contained in:
27
README.md
27
README.md
@@ -4,3 +4,30 @@ This is a framework for working with SQL transactions in a distributed network.
|
||||
transactions of multiple queries on different nodes and execute them later.
|
||||
|
||||
To ensure the reliability of the transactions a ledger using blockchain is used to keep track on ongoing transactions.
|
||||
|
||||
|
||||
## DBT Core
|
||||
The core library containing the DBTModule to include in your Ratpack application.
|
||||
|
||||
The DBT module can be added like so:
|
||||
```groovy
|
||||
bindings {
|
||||
module (DBTModule) { config ->
|
||||
config.ledger.remoteUrl = 'http://localhost:5050/ledger'
|
||||
config.executor.remoteUrl = 'http://localhost:5050/executor'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## DBT Demo
|
||||
|
||||
Demo application for testing the transactions.
|
||||
|
||||
The demo application has a database with one table LOGS which you can use to insert and select data from.
|
||||
|
||||
The demo can be run by running ``./gradlew :dbt-demo:run`` after which the demo is running on http://localhost:5050
|
||||
|
||||
|
||||
## DBT Test
|
||||
|
||||
The test module contains all the integration tests for the module.
|
||||
Reference in New Issue
Block a user