Skip to content

Commit 5493a87

Browse files
committed
Updated README.md
1 parent 08d6ebf commit 5493a87

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is a fork of [Chris Boulton's Diff][fork] project.
88

99
## Introduction
1010

11-
A comprehensive library for generating differences between
11+
Phalcon Diff is a comprehensive library for generating differences between
1212
two hashable objects (strings or arrays). Generated differences can be
1313
rendered in all of the standard formats including:
1414

@@ -21,6 +21,40 @@ The logic behind the core of the diff engine (ie, the sequence matcher)
2121
is primarily based on the Python difflib package. The reason for doing
2222
so is primarily because of its high degree of accuracy.
2323

24+
Please write us if you have any feedback.
25+
26+
## Get Started
27+
28+
### Requirements
29+
30+
To run this library on your project, you need at least:
31+
32+
* PHP >= 5.4
33+
34+
### Installation
35+
36+
Install [Composer][composer] in a common location or in your project:
37+
38+
```sh
39+
$ curl -s http://getcomposer.org/installer | php
40+
```
41+
42+
Create the `composer.json` file as follows:
43+
44+
```json
45+
{
46+
"require": {
47+
"phalcongelist/php-diff": "~2.0"
48+
}
49+
}
50+
```
51+
52+
Run the composer installer:
53+
54+
```sh
55+
$ php composer.phar install
56+
```
57+
2458
## Example Use
2559

2660
More complete documentation will be available shortly.
@@ -40,4 +74,5 @@ Phalcon Diff is open-sourced software licensed under the [New BSD License][licen
4074
All rights reserved.
4175

4276
[fork]: https://github.com/chrisboulton/php-diff
77+
[composer]: https://getcomposer.org
4378
[license]: https://github.com/phalcongelist/php-diff/blob/master/docs/LICENSE.txt

0 commit comments

Comments
 (0)