the-tempus-project/canary
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme and comments update

Browse Source
This commit is contained in:
Joey Kimsey
2025-02-02 18:02:51 -05:00
parent 2ec0473930
commit 9c48e66bf5
12 changed files with 68 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,12 +1,58 @@
# Canary
## Developer(s): Joey Kimsey
Canary is a PHP Library for creating and managing application logging messages. Originally paired with a browser extension for live logging, the tool now provides a standardized interface for creating managing and saving log messages as files.
Canary is a PHP Library for creating and managing application logs. Originally paired with a browser extension for live logging, the tool now provides a standardized interface for creating managing and saving log messages as files as well as displaying a front-end component for on-page debugging.
## Installation
To install simply use the composer command:
`php composer.phar require TheTempusProject/Canary`
`php composer.phar require thetempusproject/canary`
## Usage
Typical usage would be through including the package via composer.
```php
require_once VENDOR_DIRECTORY . 'autoload.php';
use TheTempusProject\Canary\Bin\Canary as Debug;
Debug::info( 'Function called' );
Debug::warn( 'This is a warning message' );
```
If you would like to use hermes autoloading, simply inclode the constants file and the autoload file inside `/bin/`.
```php
use TheTempusProject\Canary\Bin\Canary as Debug;
// Canary Constants
if ( ! defined( 'CANARY_CONSTANTS_LOADED' ) ) {
if ( defined( 'CANARY_CONFIG_DIRECTORY' ) ) {
require_once CANARY_CONFIG_DIRECTORY . 'constants.php';
}
}
// Canary Autoloader (Autoloader)
if ( ! defined( 'CANARY_AUTOLOADED' ) ) {
if ( defined( 'CANARY_ROOT_DIRECTORY' ) ) {
require_once CANARY_ROOT_DIRECTORY . 'bin' . DIRECTORY_SEPARATOR . 'autoload.php';
}
}
Debug::info( 'Function called' );
Debug::warn( 'This is a warning message' );
```
## Issues / Bugs / Contact
If anyone actually uses this library and runs into any issues, feel free to contact me and I'll look into it.
[Joey Kimsey](mailto:Joey@thetempusproject.com) - _Lead Developer_
[JoeyKimsey.com](https://JoeyKimsey.com)