Skip to content

Commit 4fbacf9

Browse files
authored
README: Add install info.
1 parent 38325b6 commit 4fbacf9

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

README.md

+28-7
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,28 @@ Simple PHP diff
33

44
Find the quick difference between two text files in PHP.
55

6+
Idea
7+
----
8+
9+
The library compares two text files very quickly and returns the object with the differences.
10+
11+
The difference has numbered lines for easy display of changes to the user. You can also read an array of changed rows as an integer array from the `Diff` object as you browse for changes.
12+
13+
📦 Installation
14+
---------------
15+
16+
It's best to use [Composer](https://getcomposer.org) for installation, and you can also find the package on
17+
[Packagist](https://packagist.org/packages/baraja-core/simple-php-diff) and
18+
[GitHub](https://github.com/baraja-core/simple-php-diff).
19+
20+
To install, simply use the command:
21+
22+
```
23+
$ composer require baraja-core/simple-php-diff
24+
```
25+
26+
You can use the package manually by creating an instance of the internal classes, or register a DIC extension to link the services directly to the Nette Framework.
27+
628
Example
729
-------
830

@@ -12,13 +34,6 @@ Diff can be rendered to HTML (with native method `SimpleDiff::renderDiff($diff)`
1234

1335
![Default theme](doc/diff-to-html.png)
1436

15-
Idea
16-
----
17-
18-
The library compares two text files very quickly and returns the object with the differences.
19-
20-
The difference has numbered lines for easy display of changes to the user. You can also read an array of changed rows as an integer array from the `Diff` object as you browse for changes.
21-
2237
How to use
2338
----------
2439

@@ -67,3 +82,9 @@ Comparison mode
6782

6883
This tool supports strict and basic comparison modes (strict mode is disabled by default).
6984
Strict mode also allows you to compare changes in different line wrapping methods (for example, `"\n"` and so on).
85+
86+
87+
📄 License
88+
-----------
89+
90+
`baraja-core/simple-php-diff` is licensed under the MIT license. See the [LICENSE](https://github.com/baraja-core/template/blob/master/LICENSE) file for more details.

0 commit comments

Comments
 (0)