README

BunnyNet API client for PHP

Bunny.net is content delivery platform that truly hops: providing CDN, edge storage, video streaming, image optimizers and much more!

Important

This is a non-official PHP library for the Bunny.net API.

🧰 Install

composer require toshy/bunnynet-php:^8.0

📜 Documentation

The documentation is available at https://toshy.github.io/BunnyNet-PHP.

🛠️ Contribute

Features and bugfixes should be based on the master branch.

Prerequisites

• Docker Compose
• Task (optional)

Install dependencies

task composer:install 

Enable pre-commit hook

task git:hooks

Note

Checks for phpcs, phpstan, phpmd and phpunit are executed when committing. You can also run these checks with task contribute.

🤖 Automated PRs

This repository has a workflow run (see generator) that creates or updates existing models based on the latest OpenAPI specifications and subsequently creates a (draft) PR for these changes. You can identify these automated PRs with the labels OpenAPI and automated.

The automated PRs contain two tasks:

• Add/Update API models
• Add/Update documentation examples (when needed)

The first task is already done by the generator, but if you want to fix the other task, please use the following way of working.

1. Fork the repository and make sure to copy all branches (not just master).
2. Create a branch based on the automated PR branch.
   • The automated branches will be named generator/update-api-models.
3. Make the desired changes in your own branch.
4. Create a PR with your branch, denote your changes and reference the existing automated (draft) PR.

❕ Licence

This repository comes with a MIT license.