Skip to content

zestic/php-library-template

Your Library Name

Latest Version codecov PHP Version Tests License

A brief description of what your library does and why it's useful.

Features

  • Feature 1
  • Feature 2
  • Feature 3

Requirements

  • PHP 8.3 or higher
  • Composer

Installation

Install via Composer:

composer require your-vendor/your-package

Quick Start

Remove Example Code: Run composer remove-example to remove the Calculator example and get a clean slate.

<?php

use YourVendor\YourPackage\YourClass;

// Basic usage example
$instance = new YourClass();
$result = $instance->doSomething();

Usage

Basic Usage

// Example 1: Basic functionality
$example = new YourClass();
$result = $example->method();

Advanced Usage

// Example 2: Advanced functionality
$example = new YourClass([
    'option1' => 'value1',
    'option2' => 'value2',
]);

API Documentation

For complete API documentation, see docs/ or visit your-docs-site.com.

Testing

Run the test suite:

composer test

Run tests with coverage:

composer test:coverage

Code Quality

This project uses several tools to maintain code quality:

# Run all quality checks
composer quality

# Fix code style issues
composer cs-fix

# Run static analysis
composer phpstan

Contributing

Please see CONTRIBUTING.md for details on how to contribute to this project.

Security

If you discover any security-related issues, please see SECURITY.md for information on how to report them.

Changelog

Please see CHANGELOG.md for more information on what has changed recently.

License

This project is licensed under the Apache License 2.0. Please see LICENSE for more information.

Credits

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages