Skip to content

Readme update #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 3, 2020
Merged

Readme update #37

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c4e77c
Update README.md
JBlond Jul 2, 2020
bae640e
Update README.md
JBlond Jul 2, 2020
5cd9113
Hide images by default, to have a shorter readme
JBlond Jul 2, 2020
99150a4
Correct typo in wording
JBlond Jul 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ composer require jblond/php-diff

## Example Use

<details><summery>&nbsp;</summery><br>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a typo in the <summary> tags.
Are you sure you want the content to be a non breaking space instead of a description?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, I guess it didn't work in the first place because of the typo.


```PHP
<?php
use jblond\Autoloader;
Expand Down Expand Up @@ -61,8 +63,12 @@ $renderer = new SideBySide([
echo $diff->Render($renderer);
```

</details>

### Example Output
A quick usage example can be found in the `example/` directory and under example.php.
A quick usage example can be found in the `example/` directory and under example.php. Included is a light theme and a dark theme.

<details><summery>Example Pictures</summery><br>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a typo in the <summary> tags.


#### HTML Side By Side Example
![HTML Side By Side Example](htmlSideBySide.png "HTML Side By Side Example")
Expand All @@ -75,6 +81,8 @@ A quick usage example can be found in the `example/` directory and under example
#### Text Context Example
![Text Context Example](textContext.png "Text Context Example")

</details>

## Requirements

* PHP 7.2 or greater
Expand Down