Skip to content

Commit 44e4daa

Browse files
Adjusted Readme and extended docs
1 parent 970eaf2 commit 44e4daa

6 files changed

Lines changed: 169 additions & 30 deletions

File tree

README.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ The library provides following features:
1919

2020
* Enforces the
2121
**[Spring data repository concept](https://docs.spring.io/spring-data/jpa/reference/repositories/core-concepts.html)**
22-
for EclipseStore by using [working copies](#working-copies)
23-
* **[Drop in compatible](#usage)** for your existing Spring application
22+
for EclipseStore by
23+
using [working copies](https://xdev-software.github.io/spring-data-eclipse-store/working-copies.html)
24+
* **[Drop in compatible](https://xdev-software.github.io/spring-data-eclipse-store/installation.html#drop-in-compatible)** for your existing Spring application
2425
* Utilizes **ultra-fast EclipseStore serializing and storing**
2526
* Enables your application to **select
2627
any [EclipseStore target](https://docs.eclipsestore.io/manual/storage/storage-targets/index.html)** (e.g.
@@ -37,21 +38,13 @@ GB of data are stored. ([IBM Cloud Pricing](https://cloud.ibm.com/estimator/esti
3738
AWS. ([AWS Pricing Calculator](https://calculator.aws/#/estimate?id=ab85cddf77f0d1aa0457111ed82785dfb836b1d8), as of
3839
08.01.2024)
3940

40-
### Working copies
41+
## Installation & Usage
4142

42-
If you use EclipseStore without our library, EclipseStore loads the data from the datastore directly into memory. You make your changes on these loaded Java objects and by calling ``store`` EclipseStore writes it directly from memory to the datastore.
43+
[**Installation
44+
guide** for the latest release](https://github.com/xdev-software/spring-data-eclipse-store/releases/latest#Installation)
4345

44-
![Native behavior of EclipseStore](assets/WorkingCopy_1.svg)
45-
46-
If you e.g. change the address of a person, the changed address is already in your data model, **even before storing** this person.
47-
This is very different from the behavior a Spring user expects.
48-
49-
With *Spring-Data-Eclipse-Store* every time an object is loaded from the datastore, a working copy of that object (or rather the object tree) is created and returned to the user. Therefore, the user can make the changes on the working copy without any changes to the actual data model. The changes are only persisted after calling ``save`` on a repository.
50-
51-
![Behavior of EclipseStore with Spring-Data-Eclipse-Store](assets/WorkingCopy_2.svg)
52-
53-
## Installation
54-
[Installation guide for the latest release](https://github.com/xdev-software/spring-data-eclipse-store/releases/latest#Installation)
46+
[**Detailed
47+
instructions** are in the documentation](https://xdev-software.github.io/spring-data-eclipse-store/installation.html)
5548

5649
### Supported versions
5750

@@ -60,10 +53,6 @@ With *Spring-Data-Eclipse-Store* every time an object is loaded from the datasto
6053
| ``<= 1.0.2`` | ``17`` | ``3.2.2`` | ``1.1.0`` |
6154
| ``1.0.3`` | ``17`` | ``3.2.3`` | ``1.2.0`` |
6255

63-
### Usage
64-
65-
After adding the library in your dependencies, using it is as easy as adding the ``@EnableEclipseStoreRepositories`` annotation to your ``@SpringBootApplication`` annotation.
66-
6756
## Demo
6857

6958
To see how easy it is to implement EclipseStore in your Spring project, take a look at the three

assets/WorkingCopy_1.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

assets/WorkingCopy_2.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 154 additions & 0 deletions
Loading

docs/modules/ROOT/pages/index.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
= Overview
22

3-
== About Spring-Data-Eclipse-Store
3+
image::Logo.svg[Logo XDEV Spring-Data-Eclipse-Store,200]
44

5-
A library to simplify using https://eclipsestore.io/[EclipseStore] in the https://spring.io/projects/spring-data/[Spring environment].
5+
== About {product-name}
6+
7+
A Open-Source library to simplify using https://eclipsestore.io/[EclipseStore] in a https://spring.io/projects/spring-data/[Spring environment].
68

79
What makes this library special is, that it creates a xref:working-copies.adoc[working copy] of the data.
810
This way EclipseStore behaves almost exactly like relational database from a coding perspective.

docs/modules/ROOT/pages/installation.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,6 @@ To see how easy it is to implement EclipseStore in your Spring project, take a l
4242
A https://github.com/xdev-software/spring-data-eclipse-store/tree/develop/spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/simple[simple], a more https://github.com/xdev-software/spring-data-eclipse-store/tree/develop/spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/complex[complex demo] and a https://github.com/xdev-software/spring-data-eclipse-store/tree/develop/spring-data-eclipse-store-jpa/src/main/java/software/xdev/spring/data/eclipse/store/jpa[demo with coexisting JPA].
4343

4444
== Drop in compatible [[drop-in-compatible]]
45-
//TODO
45+
46+
After adding the dependency and the annotation you are ready to go.
47+
This makes this library drop in compatible for Spring-Data projects.

0 commit comments

Comments
 (0)