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.

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

merged 4 commits into from
Jul 3, 2020

Conversation

JBlond
Copy link
Owner

@JBlond JBlond commented Jul 2, 2020

No description provided.

@JBlond JBlond requested a review from DigiLive July 2, 2020 13:13
README.md Outdated
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.

README.md Outdated
@@ -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.

Copy link
Collaborator

@DigiLive DigiLive left a comment

Choose a reason for hiding this comment

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

I've made some inline remarks.

I'm not sure the details/summary tags are widely used, but make sure the readers will understand a click on the element will open/close a block.

Copy link
Collaborator

@DigiLive DigiLive left a comment

Choose a reason for hiding this comment

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

Might be the <br> tags at line 28 and 71 are redundant.
But they don't hurt anyway.

@JBlond JBlond merged commit 5a20d89 into master Jul 3, 2020
@JBlond JBlond deleted the readme-update branch July 8, 2020 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants