Skip to content

Commit bf686a2

Browse files
committed
Prepare for being a new package
Signed-off-by: Jack Cherng <jfcherng@gmail.com>
1 parent 04fb079 commit bf686a2

File tree

2 files changed

+11
-16
lines changed

2 files changed

+11
-16
lines changed

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,6 @@ Generated diff can be rendered in all of the standard formats including:
1616
- Inline (HTML)
1717
- Side by Side (HTML)
1818

19-
The logic behind the core of the diff engine (i.e., the sequence matcher) is primarily based on the [Python difflib package](https://docs.python.org/3/library/difflib.html).
20-
The reason for doing so is primarily because of its high degree of accuracy.
21-
22-
23-
# Changes After Forking
24-
25-
- Various bug fixes and performance rewrites.
26-
- Install with Composer.
27-
- UTF-8-ready.
28-
- Follow `PSR-1`, `PSR-2`, `PSR-4`.
29-
- Utilize PHP 7.1 features and make it type-hinted.
30-
- Add `Json` template.
31-
- Add char-level and word-level diff for HTML templates.
32-
- Add classes `DiffHelper` and `RendererFactory` for simple usage.
33-
- Add multi-language support (English, Chinese, etc...) for templates.
34-
3519

3620
# Requirements
3721

@@ -197,6 +181,13 @@ $result = $diff->render($renderer);
197181
```
198182

199183

184+
# Acknowledgment
185+
186+
This package is built on the top of [chrisboulton/php-diff](https://github.com/chrisboulton/php-diff) initially.
187+
But the original repository looks like no longer maintained.
188+
Here have been quite lots of rewrites and new features since then, hence I re-started this as a new package for better visibility.
189+
190+
200191
Supporters <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ATXYY9Y78EQ3Y" target="_blank"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" /></a>
201192
==========
202193

src/Utility/SequenceMatcher.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
/**
88
* Sequence matcher for Diff.
9+
*
10+
* The logic behind the diff engine is primarily based on the Python difflib package.
11+
*
12+
* @see https://docs.python.org/3/library/difflib.html
913
*/
1014
class SequenceMatcher
1115
{

0 commit comments

Comments
 (0)