CFC-Servers/gm_logger
1
0
Fork 0
mirror of https://github.com/CFC-Servers/gm_logger.git synced 2025-03-04 03:03:01 -05:00
Code Issues Releases Activity

Merge pull request #10 from CFC-Servers/readme/add-require-examples

Browse Source 
Update README with require examples
This commit is contained in:
pierce 2020-09-05 20:19:35 -04:00 committed by GitHub
commit 86d9c12fd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -13,6 +13,8 @@ CFCLogger lets you create and configure your own logging object to be used in yo
Barebones usage example:
```lua
require( "cfclogger" )
local logger = CFCLogger( "MyProjectName" )
logger:trace( "This is an trace message!" )
@ -39,6 +41,8 @@ Any message sent with a lower log-level than the one defined in the logger objec
As an example, if you set the default log level to `"error"`, then only `"error"` and `"fatal"` messages are printed.
```lua
require( "cfclogger" )
local logger = CFCLogger( "MyProjectName", "error" )
logger:trace( "This is an trace message!" )
@ -60,6 +64,7 @@ Log levels can be changed after instantiation.
For example,
```lua
require( "cfclogger" )
local logger = CFCLogger( "MyProjectName", "error" )
print( logger.logLevel )
@ -89,6 +94,8 @@ MyLoggingInstance:on( logLevel ):call( myCallback )
In an example:
```lua
require( "cfclogger" )
local function forwardFatalToDiscord( message )
-- send the message to discord
print( "Sending fatal message to discord! ( " .. message .. ")" )
@ -112,6 +119,8 @@ This means that if your log level is set to `"error"`, but you add a callback to
As an example:
```lua
require( "cfclogger" )
local logger = CFCLogger( "MyProject", "fatal" )
logger:on( "warn" ):call(function(message) print("I'm a 'warn' callback!") end)