Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 8a6206e

Browse filesBrowse files
authored
Update README.md
Fix spelling.
1 parent ba00888 commit 8a6206e
Copy full SHA for 8a6206e

1 file changed

+21-21Lines changed: 21 additions & 21 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎README.md‎

Copy file name to clipboardExpand all lines: README.md
+21-21Lines changed: 21 additions & 21 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,38 @@
44

55
[![Build Status](https://travis-ci.org/java-diff-utils/java-diff-utils.svg?branch=master)](https://travis-ci.org/java-diff-utils/java-diff-utils)
66

7-
[![Build Status using Github Actions](https://github.com/java-diff-utils/java-diff-utils/workflows/Java%20CI%20with%20Maven/badge.svg)](https://github.com/java-diff-utils/java-diff-utils/actions?query=workflow%3A%22Java+CI+with+Maven%22)
7+
[![Build Status using GitHub Actions](https://github.com/java-diff-utils/java-diff-utils/workflows/Java%20CI%20with%20Maven/badge.svg)](https://github.com/java-diff-utils/java-diff-utils/actions?query=workflow%3A%22Java+CI+with+Maven%22)
88

99
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/002c53aa0c924f71ac80a2f65446dfdd)](https://www.codacy.com/gh/java-diff-utils/java-diff-utils/dashboard?utm_source=github.com&utm_medium=referral&utm_content=java-diff-utils/java-diff-utils&utm_campaign=Badge_Grade)
1010

1111
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.java-diff-utils/java-diff-utils/badge.svg)](http://maven-badges.herokuapp.com/maven-central/io.github.java-diff-utils/java-diff-utils)
1212

1313
## Intro
1414

15-
Diff Utils library is an OpenSource library for performing the comparison operations between texts: computing diffs, applying patches, generating unified diffs or parsing them, generating diff output for easy future displaying (like side-by-side view) and so on.
15+
Diff Utils library is an open source library for performing comparison operations between texts: computing diffs, applying patches, generating unified diffs or parsing them, generating diff output for easy future displaying (like side-by-side view) and so on.
1616

17-
Main reason to build this library was the lack of easy-to-use libraries with all the usual stuff you need while working with diff files. Originally it was inspired by JRCS library and it's nice design of diff module.
17+
The main reason to build this library was the lack of easy-to-use libraries with all the usual stuff you need while working with diff files. Originally it was inspired by JRCS library and its nice design of diff module.
1818

1919
**This is originally a fork of java-diff-utils from Google Code Archive.**
2020

2121
## GPG Signature Validation
2222

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

2525
## API
2626

27-
Javadocs of the actual release version: [JavaDocs java-diff-utils](https://java-diff-utils.github.io/java-diff-utils/4.10/docs/apidocs/)
27+
Javadocs of the actual release version: [Javadocs java-diff-utils](https://java-diff-utils.github.io/java-diff-utils/4.10/docs/apidocs/)
2828

2929
## Examples
3030

31-
Look [here](https://github.com/java-diff-utils/java-diff-utils/wiki) to find more helpful informations and examples.
31+
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 this 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 at the *Examples* page:
3434

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

3737
```Java
38-
//create a configured DiffRowGenerator
38+
// Create a configured DiffRowGenerator
3939
DiffRowGenerator generator = DiffRowGenerator.create()
4040
.showInlineDiffs(true)
4141
.mergeOriginalRevised(true)
@@ -44,15 +44,15 @@ DiffRowGenerator generator = DiffRowGenerator.create()
4444
.newTag(f -> "**") //introduce markdown style for bold
4545
.build();
4646

47-
//compute the differences for two test texts.
47+
// Compute the differences for two test texts
4848
List<DiffRow> rows = generator.generateDiffRows(
49-
Arrays.asList("This is a test senctence."),
49+
Arrays.asList("This is a test sentence."),
5050
Arrays.asList("This is a test for diffutils."));
51-
51+
5252
System.out.println(rows.get(0).getOldLine());
5353
```
5454

55-
This is a test ~senctence~**for diffutils**.
55+
This is a test ~sentence~**for diffutils**.
5656

5757
**Producing a side by side view of computed differences.**
5858

@@ -64,9 +64,9 @@ DiffRowGenerator generator = DiffRowGenerator.create()
6464
.newTag(f -> "**")
6565
.build();
6666
List<DiffRow> rows = generator.generateDiffRows(
67-
Arrays.asList("This is a test senctence.", "This is the second line.", "And here is the finish."),
67+
Arrays.asList("This is a test sentence.", "This is the second line.", "And here is the finish."),
6868
Arrays.asList("This is a test for diffutils.", "This is the second line."));
69-
69+
7070
System.out.println("|original|new|");
7171
System.out.println("|--------|---|");
7272
for (DiffRow row : rows) {
@@ -76,14 +76,14 @@ for (DiffRow row : rows) {
7676

7777
|original|new|
7878
|--------|---|
79-
|This is a test ~senctence~.|This is a test **for diffutils**.|
79+
|This is a test ~sentence~.|This is a test **for diffutils**.|
8080
|This is the second line.|This is the second line.|
8181
|~And here is the finish.~||
8282

8383
## Main Features
8484

85-
* computing the difference between two texts.
86-
* capable to hand more than plain ascii. Arrays or List of any type that implements hashCode() and equals() correctly can be subject to differencing using this library
85+
* 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
8787
* patch and unpatch the text with the given patch
8888
* parsing the unified diff format
8989
* producing human-readable differences
@@ -95,10 +95,10 @@ for (DiffRow row : rows) {
9595

9696
### Algorithms
9797

98-
* Myer's diff
98+
* Myers diff
9999
* HistogramDiff
100100

101-
But it can easily replaced by any other which is better for handing your texts. I have plan to add implementation of some in future.
101+
But it can easily be replaced by any other which is better for handling your texts. I have a plan to add the implementation of some in the future.
102102

103103
## Source Code conventions
104104

@@ -123,7 +123,7 @@ This is a valid piece of source code:
123123

124124
### To Install
125125

126-
Just add the code below to your maven dependencies:
126+
Just add the code below to your Maven dependencies:
127127

128128
```xml
129129
<dependency>
@@ -133,7 +133,7 @@ Just add the code below to your maven dependencies:
133133
</dependency>
134134
```
135135

136-
or using gradle:
136+
or using Gradle:
137137

138138
```groovy
139139
// https://mvnrepository.com/artifact/io.github.java-diff-utils/java-diff-utils

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.