Skip to content

Commit

Permalink
chore: readme update.
Browse files Browse the repository at this point in the history
  • Loading branch information
gbpii committed Dec 20, 2024
1 parent 6b58484 commit 404e382
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Publish to NPM](https://github.com/unovatria/lelog/actions/workflows/publish.yml/badge.svg)](https://github.com/unovatria/lelog/actions/workflows/publish.yml)

# LELOG - lelog

A dual-environment logger that automatically switches between server and client logging.
Expand Down Expand Up @@ -40,26 +42,26 @@ lelog.info('Custom logger message', true); // true bool adds timestamp output to
## lelog types:

- Standard logging with multi-color

`lelog.info('Standart info log 🚀🚀🚀');`

`lelog.warn('Standart warning log');`

`lelog.error('Standart error log');`
- Custom colored message usages:

`lelog.logColored('Custom colored log message', { message: '#8e44ad', className: '#F5eead' });`
- Background colored log message usage:

`lelog.logWithBackground('Log message with background', '#2ecc71');`
- Gradient message usage:

`lelog.logGradient('Gradient colored log message 01234567890123456789012345678901234567890');`
- Boxed message usage:

`lelog.logBox('Info log in a box', '#2ecc71');`
- Log group usage:

`lelog.logGroup('Log group message', { action: 'click', element: 'button', });`

## Showcase & Usage examples:
Expand All @@ -75,3 +77,4 @@ lelog.info('Custom logger message', true); // true bool adds timestamp output to
(with time bool true (that bool is optional if not entered "false" will be default))

![image]()

0 comments on commit 404e382

Please sign in to comment.