lxm_front/Mergely
1
0
Fork 1
mirror of synced 2025-11-06 04:30:40 +08:00
Code Issues Projects Releases Wiki Activity

chore: updated docs

Browse Source
This commit is contained in:
Jamie Peabody
2018-08-06 13:01:13 +01:00
parent 6716096215
commit 2c8f6cd340
2 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.md
View File

@@ -1,5 +1,8 @@
# Changes # Changes
## 4.0.7
* chore: updated documentation
## 4.0.6 ## 4.0.6
* #89: fixes missing merge buttons * #89: fixes missing merge buttons

6
README.md
View File

@@ -9,6 +9,9 @@ Mergely is a javascript component to diff/merge files interactively in a browser
### Installation via webpack ### 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 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.
### Angular 6.1.1
You can also use mergely within angular. You can start by cloning [mergely-angular](https://github.com/wickedest/mergely-angular).
### Installation via .tgz ### Installation via .tgz
Unpack mergely.tgz into a folder, e.g. `./lib`, and then add the following to the `<head>` of your target html source file. Unpack mergely.tgz into a folder, e.g. `./lib`, and then add the following to the `<head>` of your target html source file.
@@ -46,9 +49,6 @@ The following example can be used to set the `lhs` and `rhs` editors synchronous
```js ```js
$(document).ready(function () { $(document).ready(function () {
// initialize mergely
$('#mergely').mergely();
// set editor content // set editor content
$('#mergely').mergely({ $('#mergely').mergely({
lhs: function(setValue) { lhs: function(setValue) {