diff options
author | Kenny Katzgrau <ext.kkatzgrau@hexiscyber.com> | 2015-03-05 15:19:09 -0500 |
---|---|---|
committer | Kenny Katzgrau <ext.kkatzgrau@hexiscyber.com> | 2015-03-05 15:19:09 -0500 |
commit | fba7bf2ce2fd957904ebf26122fa2acfb4b28217 (patch) | |
tree | 7f214d89e2ff9d23e5e60bdb1d36c6b959faabb5 | |
parent | 969d38c5e3816eee11adce1d10d61754aa71c7a3 (diff) | |
download | KLogger-fba7bf2ce2fd957904ebf26122fa2acfb4b28217.zip KLogger-fba7bf2ce2fd957904ebf26122fa2acfb4b28217.tar.gz KLogger-fba7bf2ce2fd957904ebf26122fa2acfb4b28217.tar.bz2 |
Update docs, closes #38
-rw-r--r-- | README.markdown | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 9f24b1e..00dfce4 100644 --- a/README.markdown +++ b/README.markdown @@ -114,6 +114,28 @@ $logger->error('Uh Oh!'); // Will be logged $logger->info('Something Happened Here'); // Will be NOT logged ``` +### Additional Options + +KLogger supports additional options via third parameter in the constructor: + +``` php +<?php +// Example +$logger = new Katzgrau\KLogger\Logger('/var/log/', Psr\Log\LogLevel::WARNING, array ( + 'extension' => 'log', // changes the log file extension +)); +``` + +Here's the full list: + +| Option | Default | Description | +| ------ | ------- | ----------- | +| extension | 'txt' | The log file extension | +| prefix | 'log_' | The log file prefix | +| dateFormat | 'Y-m-d G:i:s.u' | The format of the date in the start of the log lone (php formatted) | +| flushFrequency | `false` (disabled) | How many lines to flush the output buffer after | + + ## Why use KLogger? Why not? Just drop it in and go. If it saves you time and does what you need, |