Skip to content

Commit c42ba09

Browse files
authored
Update README.md
More typo fixing.
1 parent c6b79a6 commit c42ba09

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The main reason to build this library was the lack of easy-to-use libraries with
2020

2121
## GPG Signature Validation
2222

23-
The gpg singing key in [KEYS] is used for this project's artifacts.
23+
The GPG signing key in [KEYS] is used for this project's artifacts.
2424

2525
## API
2626

@@ -30,18 +30,18 @@ Javadocs of the actual release version: [Javadocs java-diff-utils](https://java-
3030

3131
Look [here](https://github.com/java-diff-utils/java-diff-utils/wiki) to find more helpful information and examples.
3232

33-
These two outputs are generated using java-diff-utils. The source code can also be found at the *Examples* page:
33+
These two outputs are generated using java-diff-utils. The source code can also be found on the [Examples](https://github.com/java-diff-utils/java-diff-utils/wiki/Examples) page:
3434

3535
**Producing a one liner including all difference information.**
3636

37-
```Java
37+
```java
3838
// Create a configured DiffRowGenerator
3939
DiffRowGenerator generator = DiffRowGenerator.create()
4040
.showInlineDiffs(true)
4141
.mergeOriginalRevised(true)
4242
.inlineDiffByWord(true)
43-
.oldTag(f -> "~") //introduce markdown style for strikethrough
44-
.newTag(f -> "**") //introduce markdown style for bold
43+
.oldTag(f -> "~") // Introduce markdown style for strikethrough
44+
.newTag(f -> "**") // Introduce markdown style for bold
4545
.build();
4646

4747
// Compute the differences for two test texts
@@ -54,9 +54,9 @@ System.out.println(rows.get(0).getOldLine());
5454

5555
This is a test ~sentence~**for diffutils**.
5656

57-
**Producing a side by side view of computed differences.**
57+
**Producing a side-by-side view of computed differences.**
5858

59-
```Java
59+
```java
6060
DiffRowGenerator generator = DiffRowGenerator.create()
6161
.showInlineDiffs(true)
6262
.inlineDiffByWord(true)
@@ -83,15 +83,15 @@ for (DiffRow row : rows) {
8383
## Main Features
8484

8585
* Computing the difference between two texts.
86-
* Capable to handle more than plain ASCII. Arrays or List of any type that implements hashCode() and equals() correctly can be subject to differencing using this library
87-
* patch and unpatch the text with the given patch
88-
* parsing the unified diff format
89-
* producing human-readable differences
90-
* inline difference construction
86+
* Capable of handling more than plain ASCII. Arrays or lists of any type that implement `hashCode()` and `equals()` correctly can be subject to differencing using this library
87+
* Patch and unpatch the text with the given patch
88+
* Parsing the unified diff format
89+
* Producing human-readable differences
90+
* Inline difference construction
9191
* Algorithms:
92-
* Myers Standard Algorithm
92+
* Myers standard algorithm
9393
* Myers with linear space improvement
94-
* HistogramDiff using JGit Library
94+
* HistogramDiff using the JGit library
9595

9696
### Algorithms
9797

@@ -102,7 +102,7 @@ But it can easily be replaced by any other which is better for handling your tex
102102

103103
## Source Code conventions
104104

105-
Recently a checkstyle process was integrated into the build process. java-diff-utils follows the sun java format convention. There are no TABs allowed. Use spaces.
105+
Recently a checkstyle process was integrated into the build process. java-diff-utils follows the Sun Java format convention. There are no tabs allowed. Use spaces.
106106

107107
```java
108108
public static <T> Patch<T> diff(List<T> original, List<T> revised,

0 commit comments

Comments
 (0)