Skip to content

Commit 247ddb1

Browse files
committed
update readme
1 parent c6977f3 commit 247ddb1

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
PHP Diff Class
2-
--------------
1+
# PHP Diff Class
32

43
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/aa609edb-cdb1-45cf-ad51-afbdab48f6a1/mini.png)](https://insight.sensiolabs.com/projects/aa609edb-cdb1-45cf-ad51-afbdab48f6a1) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/db5f8d57b1234502aeb852afc87e0dfe)](https://www.codacy.com/app/leet31337/php-diff)
54

65
[![Latest Version](https://img.shields.io/github/release/JBlond/php-diff.svg?style=flat-square&label=Release)](https://github.com/JBlond/php-diff/releases)
76

8-
Introduction
9-
------------
7+
## Introduction
8+
109
A comprehensive library for generating differences between
1110
two hashable objects (strings or arrays). Generated differences can be
1211
rendered in all of the standard formats including:
@@ -19,40 +18,46 @@ The logic behind the core of the diff engine (ie, the sequence matcher)
1918
is primarily based on the Python difflib package. The reason for doing
2019
so is primarily because of its high degree of accuracy.
2120

22-
Example Use
23-
-----------
21+
22+
## Install
23+
24+
```
25+
composer require jblond/php-diff
26+
```
27+
28+
## Example Use
29+
2430
A quick usage example can be found in the example/ directory and under
2531
example.php.
2632

2733
![Example Image](readme.png "Example")
2834

2935
![Example 2 Image](readme2.png "Example2")
3036

31-
Requirements
32-
-----------
37+
## Requirements
38+
3339
- PHP 7.1 or greater
3440
- PHP Multibyte String
3541

36-
Merge files using jQuery
37-
------------------------
42+
## Merge files using jQuery
43+
3844
Xiphe has build a jQuery plugin with that you can merge the compared
3945
files. Have a look at [jQuery-Merge-for-php-diff](https://github.com/Xiphe/jQuery-Merge-for-php-diff).
4046

41-
Todo
42-
----
47+
## Todo
48+
4349
* Ability to ignore blank line changes
4450
* 3 way diff support
4551
* Performance optimizations
4652

47-
Contributors
48-
---------------------
53+
## Contributors
54+
4955
Contributors since I forked the repo.
5056

5157
- maxxer
5258
- Creris
5359
- jfcherng
5460

55-
License (BSD License)
56-
---------------------
61+
### License (BSD License)
5762

5863
see [License](LICENSE)

0 commit comments

Comments
 (0)