Skip to content
This repository was archived by the owner on Oct 4, 2018. It is now read-only.

Commit 939d523

Browse files
committed
Modified README
1 parent 2839c1a commit 939d523

1 file changed

Lines changed: 17 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,45 @@
11
# Java Object Diff
22

3-
An easy-to-use Framework to detect and handle differences between Java objects.
3+
An easy-to-use Framework to find and handle differences between Java objects.
44

55
## Getting Started
66

7-
To learn how to use **java-object-diff**, please have a look at the short [starter guide](https://github.com/SQiShER/java-object-diff/wiki/Getting-Started).
7+
To learn how to use **Java Object Diff**, please have a look at the short [starter guide](https://github.com/SQiShER/java-object-diff/wiki/Getting-Started).
88

99
## Use Cases
1010

11-
This Framework is currently used to…
11+
**Java Object Diff** is currently used to…
1212

1313
* Generate Facebook-like activity streams
1414
* Visualize the differences between two object versions
1515
* Automatically resolve conflicts on concurrent database writes
1616
* Detect and persist only properties that actually changed
1717

18-
None one of these solutions comes out-of-the-box, though. But this Framework was the solid foundation, that made them very easy to realize.
18+
Even though none one of the above solutions comes out-of-the-box, this framework made them very easy to realize.
1919

2020
## Feature List
2121

2222
* Generates a graph of your object, allowing you to build powerful visitors to suit your needs.
2323
* Works with every kind of object, so no need to change a thing.
24-
* Can be configured entirely from the outside. No annotations needed. (Although they make it much more convenient.)
24+
* Can be configured entirely from the outside. No annotations needed. (Although they exist and make it more convenient.)
25+
* Properties can be grouped into categories, to easily compare specific groups of properties.
2526
* No dependencies except for SLF4J.
2627

27-
## Disclaimer
28+
## Note
2829

29-
Although I use this Framework in a rather complex project of mine, I'm sure there are still lots of corner cases, that I didn't discover myself. Fortunately, the simple API makes it very easy for you, to quickly test it out on your own set of objects.
30+
Although I successfully use this framework in a rather complex project for quite a while now, I'm sure there are still many
31+
edge cases, that I didn't even think about. Fortunately, the simple API makes it easy for you, to test it on your own set of
32+
objects, to see if it works for you.
3033

31-
## Known Issues and Ways to Improve
34+
## Ways to Improve
3235

3336
* Performance optimization was not the biggest concern so far, so there is still some room for improvement.
3437
* Object comparison is very strict. Objects with different types cannot be compared, even when they share the same interface.
35-
* Arrays are treated poorly
3638
* The annotations should be applied to fields instead of methods. (Would make it easier to handle Arrays.)
39+
* It would be great to integrate a text-based diff algorithm for regular Strings.
3740
* Documentation, documentation, documentation...
41+
42+
## Known Issues and
43+
44+
* Arrays are treated poorly (Actually not at all. Yet.)
45+
* Objects serving as map keys should be compared as well. Currently their only purpose is to identify map values.

0 commit comments

Comments
 (0)