diff --git a/README.md b/README.md index 59d98b5..91e6aed 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# cron-contracts -Contracts for the cron manager +# Contracts for the cron manager + +[![Continuous Integration](https://github.com/MammatusPHP/cron-contracts/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/MammatusPHP/cron-contracts/actions/workflows/ci.yml) +[![Latest Stable Version](https://poser.pugx.org/mammatus/cron-contracts/v/stable.png)](https://packagist.org/packages/mammatus/cron-contracts) +[![Total Downloads](https://poser.pugx.org/mammatus/cron-contracts/downloads.png)](https://packagist.org/packages/mammatus/cron-contracts) +[![License](https://poser.pugx.org/mammatus/cron-contracts/license.png)](https://packagist.org/packages/mammatus/cron-contracts) + +# Installation + +To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`. + +``` +composer require mammatus/cron-contracts +``` + +# Usage + +See the [cron](https://github.com/MammatusPHP/cron) package on usage. + +# License + +The MIT License (MIT) + +Copyright (c) 2024 Cees-Jan Kiewiet + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +