Skip to content

Commit 1d457fe

Browse files
committed
Added customizable options to README
1 parent aef36ec commit 1d457fe

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,46 @@ Check out the [customizable options](#customizable-options) below.
4646
in the [jsfiddle demo](#demo).
4747

4848
#### Customizable options
49+
+ Either mark up your HTML to use the default selectors, or use these options below:
50+
51+
<table>
52+
<tr>
53+
<th>option</th>
54+
<th>default</th>
55+
<th>explanation</th>
56+
</tr>
57+
58+
<tr>
59+
<td>originalContainer</td>
60+
<td>.original</td>
61+
<td>CSS-selector for the element that holds the original text. $(elem).text() will be used to extract the text.</td>
62+
</tr>
63+
64+
<tr>
65+
<td>changedContainer</td>
66+
<td>.changed</td>
67+
<td>CSS-selector for the element that holds the changed text. $(elem).text() will be used to extract the text.</td>
68+
</tr>
69+
70+
<tr>
71+
<td>diffContainer</td>
72+
<td>.diff</td>
73+
<td>CSS-selector for the element where the diff will be put.</td>
74+
</tr>
75+
76+
<tr>
77+
<td>cleanup</td>
78+
<td>true</td>
79+
<td>Whether diff_match_patch's diff_cleanupSemantic() will be used or not. true will produce a human-redable diff, whereas false will be more to the liking of machines. See the demo for the effect.</td>
80+
</tr>
81+
82+
<tr>
83+
<td>debug</td>
84+
<td>false</td>
85+
<td>see some debug output in your browser's console</td>
86+
</tr>
87+
</table>
88+
4989

5090
## Demo
5191
[jsfiddle demo](http://jsfiddle.net/arnab/YwSVY/)

0 commit comments

Comments
 (0)