Skip to content
This repository was archived by the owner on Nov 12, 2019. It is now read-only.

Commit ba2f07b

Browse files
committed
Clean up language a little bit in docs
1 parent 3c3299f commit ba2f07b

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ To contribute do the following:
44
1. Check existing open issues.
55
2. If not found, file an issue with any relevant information (versions, steps to reproduce, stacktrace, screenshots, etc).
66
3. Fork repository.
7-
4. Create a branch on your fork and add the issue # to he name. Like feature/issue-23 or bug/issue-65.
8-
5. Try to match the style code.
9-
6. Create a pull request to develop branch.
7+
4. Create a branch on your fork and add the issue # to the name. For example: feature/issue-23 or bug/issue-65.
8+
5. Try to match your code to the existing code style.
9+
6. Create a pull request.
1010

11-
Feel free to send any question.
11+
Feel free to open an issue with any questions.

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
The java-diff-utils library is for computing diffs, applying patches, generation side-by-side view in Java.
44

5-
It 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.
5+
It is an open source library for performing comparison operations between chunks of text: computing diffs, applying patches, generating unified diffs or parsing them, generating diff output for easy future display (like a side-by-side view) and so on.
66

7-
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.
7+
The main reason for creating this library was the lack of easy-to-use libraries with all the usual features necessary for working with diff files. Originally it was inspired by the JRCS library and its nice diff module design.
88

99
**Original code and docs were forked from:** [java-diff-utils](https://code.google.com/p/java-diff-utils/)
1010

1111
## Main Features
1212

13-
* computing the difference between two texts.
14-
* capable to hand more than plain ascci. Arrays or List of any type that implements hashCode() and equals() correctly can be subject to differencing using this library
15-
* patch and unpatch the text with the given patch
16-
* parsing the unified diff format
17-
* producing human-readable differences
13+
* Computing the difference between two chunks of text.
14+
* Capable of handling more than plain ASCII. Arrays or Lists of any type that implement hashCode() and equals() correctly can be used as inputs for differencing using this library.
15+
* Patch and unpatch the text with the given patch.
16+
* Parsing the unified diff format.
17+
* Producing human-readable differences.
1818

1919
## Algorithms
2020

21-
This library implements Myer's diff algorithm. But it can easily replaced by any other which is better for handing your texts.
21+
This library implements Myers' diff algorithm, but it is modular so it is easy to replace the algorithm with another which might be better suited to your needs.
2222

2323
# Tutorial
2424

@@ -33,7 +33,7 @@ This library implements Myer's diff algorithm. But it can easily replaced by any
3333

3434
### 2.1.0
3535

36-
- Removes the dependency on Guavatime
36+
- Removes the dependency on Guava time
3737

3838
### 2.0.0
3939

0 commit comments

Comments
 (0)