Skip to content

Commit 5e7ddf3

Browse files
committed
Code Style Fixes.
1 parent 71b63a1 commit 5e7ddf3

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
A comprehensive library for generating differences between
1010
two hashable objects (strings or arrays). Generated differences can be
1111
rendered in all of the standard formats including:
12-
* Unified
13-
* Context
14-
* Inline HTML
15-
* Side by Side HTML
16-
* Unified HTML
12+
* Unified
13+
* Context
14+
* Inline HTML
15+
* Side by Side HTML
16+
* Unified HTML
1717

1818
The logic behind the core of the diff engine (ie, the sequence matcher)
1919
is primarily based on the Python difflib package. The reason for doing
@@ -22,38 +22,40 @@ so is primarily because of its high degree of accuracy.
2222

2323
## Install
2424

25-
```
25+
```shell
2626
composer require jblond/php-diff
2727
```
2828

2929
## Example Use
3030

3131
```PHP
3232
<?php
33-
// installed via composer
33+
// Installed via composer...
3434
require 'vendor/autoload.php';
35-
36-
// or installed manual
35+
// ...or installed manually.
3736
require dirname(__FILE__).'/../lib/Autoloader.php';
37+
3838
new \jblond\Autoloader();
3939

4040
$a = file_get_contents(dirname(__FILE__).'/a.txt');
4141
$b = file_get_contents(dirname(__FILE__).'/b.txt');
42-
// Options for generating the diff
42+
43+
// Options for generating the diff.
4344
$options = [
4445
//'ignoreWhitespace' => true,
4546
//'ignoreCase' => true,
4647
];
47-
// Initialize the diff class
48+
49+
// Initialize the diff class.
4850
$diff = new \jblond\Diff($a, $b, $options);
4951

50-
//choose renderer
52+
// Choose Renderer.
5153
$renderer = new \jblond\Diff\Renderer\Html\SideBySide([
5254
'title_a' => 'Custom title for OLD version',
5355
'title_b' => 'Custom title for NEW version',
5456
]);
5557

56-
//show it
58+
// Show it.
5759
echo $diff->Render($renderer);
5860
```
5961

@@ -67,8 +69,8 @@ example.php.
6769

6870
## Requirements
6971

70-
- PHP 7.2 or greater
71-
- PHP Multibyte String
72+
* PHP 7.2 or greater
73+
* PHP Multibyte String
7274

7375
## Merge files using jQuery
7476

@@ -77,25 +79,25 @@ files. Have a look at [jQuery-Merge-for-php-diff](https://github.com/Xiphe/jQuer
7779

7880
## Todo
7981

80-
* Ability to ignore blank line changes
81-
* 3 way diff support
82+
* Ability to ignore blank line changes
83+
* 3 way diff support
8284

83-
## Contributors
85+
## Contributors
8486

8587
Contributors since I forked the repo.
8688

87-
- maxxer
88-
- Creris
89-
- jfcherng
90-
- DigiLive
89+
* maxxer
90+
* Creris
91+
* jfcherng
92+
* DigiLive
9193

9294
### License (BSD License)
9395

9496
see [License](LICENSE)
9597

96-
## tests
98+
## Tests
9799

98-
```BASH
100+
```shell
99101
composer run-script phpunit
100102
composer run-script php_src
101103
composer run-script php_test

0 commit comments

Comments
 (0)