Skip to content

Commit 6b7e36b

Browse files
committed
Update readme
Signed-off-by: Jack Cherng <[email protected]>
1 parent 8b89bbc commit 6b7e36b

File tree

2 files changed

+28
-9
lines changed

2 files changed

+28
-9
lines changed

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,16 @@ A comprehensive library for generating diff between two strings.
1515

1616
Generated diff can be rendered in all of the standard formats including:
1717

18-
- Unified (Text)
19-
- Context (Text)
20-
- Json (Text)
21-
- Inline (HTML)
22-
- Side by Side (HTML)
18+
**Text** renderers:
19+
20+
- Context
21+
- Json
22+
- Unified
23+
24+
**HTML** renderers:
25+
26+
- Inline
27+
- Side by Side
2328

2429
Note that for HTML rendered results, you have to add CSS for a better visualization.
2530
You may modify one from `example/diff-table.css` or write your own from zero.
@@ -62,7 +67,9 @@ $newFile = __DIR__ . '/example/new_file.txt';
6267
$old = 'This is the old string.';
6368
$new = 'And this is the new one.';
6469

65-
// renderer class name: Unified, Context, Json, Inline, SideBySide
70+
// renderer class name:
71+
// Text renderers: Context, Json, Unified
72+
// HTML renderers: Inline, SideBySide
6673
$rendererName = 'Unified';
6774

6875
// the Diff class options
@@ -147,17 +154,29 @@ $result = $htmlRenderer->renderArray(json_decode($jsonResult, true));
147154

148155
### Renderer: Inline
149156

157+
```php
158+
<?php $rendererOptions = ['detailLevel' => 'line'];
159+
```
160+
150161
![Inline](https://raw.githubusercontent.com/jfcherng/php-diff/v6/example/images/inline-renderer.png)
151162

152163

153164
### Renderer: Side By Side
154165

166+
```php
167+
<?php $rendererOptions = ['detailLevel' => 'line'];
168+
```
169+
155170
![Side By Side](https://raw.githubusercontent.com/jfcherng/php-diff/v6/example/images/side-by-side-renderer.png)
156171

157172

158-
### Renderer: Side By Side (`lineNumbers` = `false`)
173+
### Renderer: Side By Side (no line numbers)
159174

160-
![Side By Side](https://raw.githubusercontent.com/jfcherng/php-diff/v6/example/images/side-by-side-renderer-no-line-numbers.png)
175+
```php
176+
<?php $rendererOptions = ['lineNumbers' => false];
177+
```
178+
179+
![Side By Side](https://raw.githubusercontent.com/jfcherng/php-diff/v6/example/images/side-by-side-renderer-line-numbers-false.png)
161180

162181

163182
### Renderer: Unified
@@ -184,7 +203,7 @@ $result = $htmlRenderer->renderArray(json_decode($jsonResult, true));
184203

185204
<details><summary>Click to expand</summary>
186205

187-
```
206+
```diff
188207
***************
189208
*** 1,3 ****
190209
! <p>Hello World!</p>

0 commit comments

Comments
 (0)