Skip to content

A simplified and structured way to provide configuration in your PHP project

Notifications You must be signed in to change notification settings

unicorn-fail/configuration

Repository files navigation

league/configuration

Latest Version Total Downloads Software License Build Status Coverage Status Quality Score CII Best Practices

Sponsor development of this project

league/configuration

league/configuration is a simplified and structured way to provide configuration in your PHP project

📦 Installation & Basic Usage

This project requires PHP 7.2.5 or higher. To install it via Composer simply run:

$ composer require league/configuration

NOTE: Until this is actually published in the league namespace on packagist.com, you will need to add the following to your composer.json file:

    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/unicorn-fail/configuration.git"
        }
    ],
    "require": {
        "league/configuration": "dev-main"
    }

📓 Documentation

@todo

🏷️ Versioning

SemVer is followed closely. Minor and patch releases should not introduce breaking changes to the codebase; however, they might change the resulting AST or HTML output of parsed Markdown (due to bug fixes, spec changes, etc.) As a result, you might get slightly different HTML, but any custom code built onto this library should still function correctly.

Any classes or methods marked @internal are not intended for use outside of this library and are subject to breaking changes at any time, so please avoid using them.

🛠️ Maintenance & Support

When a new minor version (e.g. 1.4 -> 1.5) is released, the previous one (1.4) will continue to receive security and critical bug fixes for at least 3 months.

When a new major version is released (e.g. 1.5 -> 2.0), the previous one (1.5) will receive critical bug fixes for at least 3 months and security updates for 6 months after that new release comes out.

(This policy may change in the future and exceptions may be made on a case-by-case basis.)

Professional support, including notification of new releases and security updates, is available through a Tidelift Subscription.

👷‍♀️ Contributing

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure with us.

Please see CONTRIBUTING for additional details.

🧪 Testing

$ composer test

👥 Credits & Acknowledgements

Sponsors

We'd also like to extend our sincere thanks the following sponsors who support ongoing development of this project:

Are you interested in sponsoring development of this project? See https://www.colinodell.com/sponsor for a list of ways to contribute.

📄 License

league/configuration is licensed under the BSD-3 license. See the LICENSE file for more details.

🏛️ Governance

This project is primarily maintained by Colin O'Dell. Members of the PHP League Leadership Team may occasionally assist with some of these duties.


Get professional support for league/configuration with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

About

A simplified and structured way to provide configuration in your PHP project

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published