Skip to content
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

Remove JSON requirement from documentation #1

Closed
garak opened this issue Aug 23, 2024 · 5 comments
Closed

Remove JSON requirement from documentation #1

garak opened this issue Aug 23, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@garak
Copy link

garak commented Aug 23, 2024

The README is reporting in the "requirements" section:

JSON extension enabled in PHP

This is useless, since the JSON extension is bundled inside php itself since 8.0 and this library requires php 8.1 or above.

By the way, you could even remove the entire "requirements" section, since it's already declared in the composer file (and all the versions below 8.1 are currently out of support)

@blancks
Copy link
Owner

blancks commented Aug 23, 2024

That's a good point, thanks!
I will remove the Requirements section altogether but i think i'll use a "php version" badge instead.
People may casually read the documentation from the github project instead of packagist and i want to make crystal clear that older versions are not supported

@blancks blancks added the documentation Improvements or additions to documentation label Aug 23, 2024
@garak
Copy link
Author

garak commented Aug 23, 2024

Good idea about the badge. May I suggest using https://poser.pugx.org/ for it?

@blancks
Copy link
Owner

blancks commented Aug 23, 2024

Love it! Thank you for the suggestion 😄

@blancks
Copy link
Owner

blancks commented Aug 23, 2024

@garak it seems i'm having a bad time using the badges, they won't display on github but they works nicely in my PHPStorm's preview. I'm surely missing something here, do you have any idea on what might be ?

immagine

@blancks
Copy link
Owner

blancks commented Aug 24, 2024

Just figured out that the github proxy url didn't liked the https redirect of the badge url.
I fixed that and shared my findings in the issue tracker of PUGX/badge-poser

@blancks blancks closed this as completed Aug 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants