Skip to content

Commit 21785d5

Browse files
Update README.md
1 parent 81ee7e4 commit 21785d5

1 file changed

Lines changed: 21 additions & 13 deletions

File tree

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# interference
2-
simple distributed persistent layer for java applications
3-
(c) 2019 head systems, ltd
4-
5-
current revision: 2019.3
6-
for detailed information see docs/InterferenceManual.pdf
7-
contacts: info@inteference.su
8-
https://github.com/interference-project/inteference
92

10-
Concepts & features
3+
##### simple distributed persistent layer for java applications
4+
##### (c) 2019 head systems, ltd
5+
##### current revision: 2019.3
6+
##### for detailed information see docs/InterferenceManual.pdf
7+
8+
##### contacts: info@inteference.su
9+
##### https://github.com/interference-project/inteference
10+
11+
12+
## Concepts & features
1113

1214
- supports Base JPA annotations
1315
- supports distributed SQL queries
@@ -24,7 +26,7 @@ Concepts & features
2426
- supports complex event processing and streaming SQL (in next release)
2527

2628

27-
Quick Start Application
29+
## Quick Start Application
2830

2931
The interference-test application shows example of using the basic
3032
interference use cases. Before starting and using, read the manual.
@@ -37,6 +39,7 @@ To get started with interference, you need to include the interference.jar
3739
library in your project configuration. For maven pom.xml, this might look
3840
like this:
3941

42+
```
4043
<dependencies>
4144
<dependency>
4245
<groupId>su.interference</groupId>
@@ -45,16 +48,19 @@ like this:
4548
</dependency>
4649
...
4750
</dependencies>
51+
```
4852

4953
Next, specify the necessary set of keys in the project
5054
(application) settings (jmxremote settings is optional):
5155

56+
```
5257
-Dsu.interference.config=interference.properties
5358
-Dcom.sun.management.jmxremote
5459
-Dcom.sun.management.jmxremote.port=8888
5560
-Dcom.sun.management.jmxremote.local.only=false
5661
-Dcom.sun.management.jmxremote.authenticate=false
5762
-Dcom.sun.management.jmxremote.ssl=false
63+
```
5864

5965
To run a single local interference node, you can use the standard
6066
supplied interference.properties configuration. Note that file
@@ -63,18 +69,20 @@ Next, see the configuration section.
6369

6470
Then, add following code into initializing section of your java application:
6571

72+
```
6673
Instance instance = Instance.getInstance();
6774
Session session = Session.getSession();
6875
instance.startupInstance(session);
76+
```
6977

70-
where Instance is su.inteference.core.Instance
71-
and Session is su.interference.persistent.Session.
78+
where Instance is su.inteference.core.Instance and Session is su.interference.persistent.Session.
7279

7380

74-
Service as standalone
81+
## Service as standalone
7582

7683
This option can be used when the cluster node is used solely for the purpose of further horizontal scaling of the data retrieving mechanism:
7784

85+
```
7886
java -cp interference.jar
7987
-Dsu.interference.config=interference.properties
8088
-Dcom.sun.management.jmxremote
@@ -83,4 +91,4 @@ java -cp interference.jar
8391
-Dcom.sun.management.jmxremote.authenticate=false
8492
-Dcom.sun.management.jmxremote.ssl=false
8593
su.interference.standalone.Start
86-
94+
```

0 commit comments

Comments
 (0)