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

Update readme with a note about versions #40

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![GitHub release](https://img.shields.io/github/release/labrador-kennel/http-cors.svg?style=flat-square)](https://github.com/labrador-kennel/http-cors/releases/latest)
[![GitHub license](https://img.shields.io/github/license/labrador-kennel/http-cors.svg?style=flat-square)](http://opensource.org/licenses/MIT)

A PHP 7+ library intended to provide spec-compliant CORS middleware for projects running on [Amp's http-server](https://amphp.org/http-server/).
A PHP library intended to provide spec-compliant CORS middleware for projects running on [Amp's http-server](https://amphp.org/http-server/).
Though this library lives under the Labrador namespace it has only one dependency, `amphp/http-server`, and does not depend
on any other Labrador packages.

Expand All @@ -20,6 +20,16 @@ composer require cspray/labrador-http-cors
Labrador packages have thorough documentation in-repo in the `docs/` directory. You can also check out the documentation
online at [https://labrador-kennel.io/docs/http-cors](https://labrador-kennel.io/docs/http-cors).

## Notice about versions

This library is compatible with all versions of amphp http server. But depending on the version of PHP you are using or
the version of amphp, you will need to pick a specific one. Learn more in the following version comparative:

| PHP | amphp | labrador-http-cors |
|------|-------|--------------------|
| 8.1+ | 3 | 0.4 |
| 7.1+ | 2 | 0.1, 0.2, 0.3 |

## Governance

All Labrador packages adhere to the rules laid out in the [Labrador Governance repo](https://github.com/labrador-kennel/governance).
Expand Down
Loading