diff --git a/README.md b/README.md index f70cf34..023237a 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,23 @@ http://mergely.com -Mergely is a javascript component to diff/merge files interactively in a browser, providing rich API that enables you to easily integrate Mergely into your existing web application. It is suitable for comparing text files online, e.g. .txt, .html, .xml, .c, .cpp, .java, etc. Mergely has a javascript implementation of the Longest Common Subsequence diff algorithm (LCS) and a customizable markup engine. +Mergely is a JavaScript component for differencing and merging files interactively in a browser (diff/merge), providing rich API that enables you to easily integrate Mergely into your existing web application. It is suitable for comparing text files online, for example, .txt, .html, .xml, .c, .cpp, .java, etc. + +Mergely has a JavaScript implementation of the Longest Common Subsequence (LCS) diff algorithm, and a customizable markup engine. ## Installation ### Installation via webpack -The recommended way to install mergely is to use npm and [webpack](https://webpack.js.org/) to install mergely and its dependencies. It is highly recommended that you start by cloning [mergely-webpack](https://github.com/wickedest/mergely-webpack). It has everything that you need to get started. +The recommended way to install mergely and its dependencies is to use a Node package manager (`npm` or `yarn`) and [webpack](https://webpack.js.org/). + +It is highly recommended that you start by cloning [mergely-webpack](https://github.com/wickedest/mergely-webpack). The webpack has everything that you need to get started. ### Angular 6.1.1 -You can also use mergely within angular. You can start by cloning [mergely-angular](https://github.com/wickedest/mergely-angular). +You can also use mergely within angular. You can start by cloning [mergely-angular](https://github.com/wickedest/mergely-angular). ### Installation via .tgz -Unpack mergely.tgz into a folder, e.g. `./lib`, and then add the following to the `` of your target html source file. +Unpack mergely.tgz into a folder, for example, `./lib`, and add the following to the `` of your target HTML source file. ```html @@ -25,7 +29,9 @@ Unpack mergely.tgz into a folder, e.g. `./lib`, and then add the following to th ``` -Create a div for the editor in ``. This example uses a style that provides 8px padding (`mergely-full-screen-8`): +Create a div for the editor in ``. + +This example uses a style that provides 8px padding (`mergely-full-screen-8`): ```html
@@ -45,7 +51,7 @@ $(document).ready(function () { ### Synchronous content initialization -The following example can be used to set the `lhs` and `rhs` editors synchronously (i.e. their contents are already known): +The following example can be used to set the `lhs` and `rhs` editors synchronously (that is, when their contents are already known): ```js $(document).ready(function () { @@ -86,7 +92,7 @@ $(document).ready(function () { |autoresize|boolean|`true`|Enables/disables the auto-resizing of the editor.| |autoupdate|boolean|`true`|Enables/disables the auto-updating of the editor when changes are made.| |bgcolor|string|`#eeeeee`|The background color that mergely fills the margin canvas with.| -|change_timeout|number|`500`|The timeout, after a text change, before Mergely calcualtes a diff. Only used when `readonly` enabled.| +|change_timeout|number|`500`|The timeout, after a text change, before Mergely calculates a diff. Only used when `readonly` is enabled.| |cmsettings|object|`{mode: 'text/plain', readOnly: false}`|CodeMirror settings (see [CodeMirror](http://codemirror.net])) that are combined with `lhs_cmsettings` and `rhs_cmsettings`.| |editor_width|string|`400px`|Starting width.| |editor_height|string|`400px`|Starting height.| @@ -100,7 +106,7 @@ $(document).ready(function () { |lhs_cmsettings|object|`{}`|The CodeMirror settings (see [CodeMirror](http://codemirror.net])) for the left-hand side editor.| |resize_timeout|number|`500`|The timeout, after a resize, before Mergely auto-resizes. Only used when autoresize enabled.| |rhs_cmsettings|object|`{}`|The CodeMirror settings (see [CodeMirror](http://codemirror.net])) for the right-hand side editor.| -|rhs_margin|string|`right`|Location for the rhs markup margin is either right or left.| +|rhs_margin|string|`right`|Location for the rhs markup margin. Possible values: right, left.| |sidebar|boolean|`true`|Enables/disables sidebar markers. Disabling can give a performance gain for large documents.| |vpcolor|string|`rgba(0, 0, 200, 0.5)`|The margin/viewport indicator color.| |viewport|boolean|`false`|Enables/disables the viewport. Enabling the viewport can give a performance gain for large documents.| @@ -243,7 +249,7 @@ $('#mergely').mergely('options'); ### resize -Resize the editor. Must be called explicitly if `autoresize` is disabled. +Resizes the editor. It must be called explicitly if `autoresize` is disabled. #### Parameters None. @@ -313,7 +319,7 @@ $('#mergely').mergely('search', 'lhs', 'needle'); ### swap -Swap the content of the left and right editors. +Swaps the content of the left and right editors. #### Parameters None. @@ -337,7 +343,7 @@ $('#mergely').mergely('unmarkup'); ### update -Manual update; recalculates diff and applies new settings. +Manually updates the editor by recalculating the diff and applying new settings. #### Parameters None.