Skip to content

Commit f2f613c

Browse files
committed
Update readme (nits)
Signed-off-by: Jack Cherng <[email protected]>
1 parent fdead6f commit f2f613c

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ Generated diff can be rendered in all of the standard formats including:
2424
Note that for HTML rendered results, you have to add CSS for a better visualization.
2525
You may modify one from `example/diff-table.css` or write your own from zero.
2626

27+
If you are okay with the default CSS, there is `\Jfcherng\Diff\DiffHelper::getStyleSheet()`
28+
which can be used to get the content of the `example/diff-table.css`.
29+
2730

2831
## Requirements
2932

@@ -33,6 +36,8 @@ You may modify one from `example/diff-table.css` or write your own from zero.
3336

3437
## Installation
3538

39+
This package is available on `Packagist` by the name of [jfcherng/php-diff](https://packagist.org/packages/jfcherng/php-diff).
40+
3641
```bash
3742
$ composer require jfcherng/php-diff
3843
```
@@ -98,7 +103,7 @@ $result = DiffHelper::calculate($old, $new, $rendererName);
98103

99104
// custom usage
100105
$differ = new Differ(explode("\n", $old), explode("\n", $new), $differOptions);
101-
$renderer = RendererFactory::make($rendererName, $rendererOptions); // or your own renderers
106+
$renderer = RendererFactory::make($rendererName, $rendererOptions); // or your own renderer object
102107
$result = $renderer->render($differ);
103108
```
104109

@@ -110,16 +115,16 @@ $result = $renderer->render($differ);
110115

111116
<table>
112117
<tr>
113-
<td>None-level</td>
114-
<td>Line-level (Default)</td>
118+
<th>None-level</th>
119+
<th>Line-level (Default)</th>
115120
</tr>
116121
<tr>
117122
<td><img src="https://raw.githubusercontent.com/jfcherng/php-diff/v6/example/images/inline-none-level-diff.png"></td>
118123
<td><img src="https://raw.githubusercontent.com/jfcherng/php-diff/v6/example/images/inline-line-level-diff.png"></td>
119124
</tr>
120125
<tr>
121-
<td>Word-level</td>
122-
<td>Char-level</td>
126+
<th>Word-level</th>
127+
<th>Char-level</th>
123128
</tr>
124129
<tr>
125130
<td><img src="https://raw.githubusercontent.com/jfcherng/php-diff/v6/example/images/inline-word-level-diff.png"></td>

example/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
To run the example at local machine, you could do the following steps.
1+
To run the example on your local machine, you can follow steps below.
22

3-
- `$ php -S localhost:12388` where `12388` is an arbitrary unused port.
4-
- Visit `http://localhost:12388/demo.php` with your browser.
3+
1. `$ php -S localhost:12388` where `12388` is an arbitrary unused port.
4+
1. Visit `http://localhost:12388/demo.php` with your web browser.

0 commit comments

Comments
 (0)