Skip to content

Commit b27fcbb

Browse files
committed
Updated README with transfer of ownership and Differ info.
1 parent f716495 commit b27fcbb

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

README.md

+28-7
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
go-difflib
22
==========
33

4-
THIS PACKAGE IS NO LONGER MAINTAINED.
4+
The previous owner of this project (pmezard) did not have the time to continue
5+
working on it. Additionally I (ianbruene) needed additional ported features.
56

6-
At this point, I have no longer the time nor the interest to work on go-difflib. I apologize for the inconvenience.
7+
I have taken over maintenance and further development of the project
78

8-
[![GoDoc](https://godoc.org/github.com/pmezard/go-difflib/difflib?status.svg)](https://godoc.org/github.com/pmezard/go-difflib/difflib)
9+
[![GoDoc](https://godoc.org/github.com/ianbruene/go-difflib/difflib?status.svg)](https://godoc.org/github.com/ianbruene/go-difflib/difflib)
910

1011
Go-difflib is a partial port of python 3 difflib package. Its main goal
11-
was to make unified and context diff available in pure Go, mostly for
12-
testing purposes.
12+
is to make unified and context diff available in pure Go.
1313

1414
The following class and functions (and related tests) have be ported:
1515

1616
* `SequenceMatcher`
17+
* `Differ`
1718
* `unified_diff()`
1819
* `context_diff()`
1920

2021
## Installation
2122

2223
```bash
23-
$ go get github.com/pmezard/go-difflib/difflib
24+
$ go get github.com/ianbruene/go-difflib/difflib
2425
```
2526

26-
### Quick Start
27+
### UnifiedDiff Quick Start
2728

2829
Diffs are configured with Unified (or ContextDiff) structures, and can
2930
be output to an io.Writer or returned as a string.
@@ -51,3 +52,23 @@ would output:
5152
+baz
5253
```
5354

55+
### Differ Quick Start
56+
57+
Differ has been implemented primarily for the Compare() function at this time.
58+
59+
```Go
60+
out, err := diff.Compare(
61+
[]string{"foo\n", "bar\n", "baz\n"},
62+
[]string{"foo\n", "bar1\n", "asdf\n", "baz\n"})
63+
```
64+
65+
would output:
66+
67+
```
68+
foo
69+
- bar
70+
+ bar1
71+
? +
72+
+ asdf
73+
baz
74+
```

0 commit comments

Comments
 (0)