README

Log Helper

Log Helper is a library of functions that helps developers add logging functionality to their scripts and applications, tightly integrated with Monolog.

Features

TODO :)

Getting Started

As an included library, with Composer:

Make sure Composer is installed - if not, you can get it from here.

First, you need to add Log Helper as a dependency in your composer.json file.

To use the current stable version, add the following to download it straight from here:

PLEASE NOTE! There is currently no stable version available, Log Helper is still under development - this is here for future reference.

"require": {
    "php": ">=7.0",
    "ion/log-helper": "1.*",
}

To use the bleeding edge (development) version, add the following:

"require": {
    "php": ">=7.1",
    "ion/log-helper": "dev-default",	
},
"repositories": {
    {
      "type": "vcs",
      "url": "https://bitbucket.org/justusmeyer/log-helper/"
    }
}

Then run the following in the root directory of your project:

php composer.phar install

As an included library, without Composer:

Download a packaged version (in .ZIP format), here

Unzip the package and make sure you include 'include.php,' like so (assuming you unzipped the package into the relative path 'includes/log-helper'):

require_once( __DIR__ . '/includes/log-helper/include.php' );

Prerequisites

PHP 7.0
Composer (optional)

Built With

Composer - Dependency Management
Phing - Used to generate custom distributions
NetBeans - IDE
PHP Storm - IDE

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Justus Meyer - Initial work - BitBucket

License

This project is licensed under the LGPL-3.0 License - see the LICENSE.md file for details.

ion / log-helper

Maintainers

Details