syntex-logger/README.md

A Basic Logging System

# SynTex Logger
A logging system for your plugin with colors.

[![NPM Recommended Version](https://img.shields.io/npm/v/syntex-logger?label=release&color=brightgreen&style=for-the-badge)](https://www.npmjs.com/package/syntex-logger)
[![NPM Beta Version](https://img.shields.io/npm/v/syntex-logger/beta?color=orange&label=beta&style=for-the-badge)](https://www.npmjs.com/package/syntex-logger)
[![NPM Downloads](https://img.shields.io/npm/dt/syntex-logger?color=9944ee&&style=for-the-badge)](https://www.npmjs.com/package/syntex-logger)
[![GitHub Commits](https://img.shields.io/github/commits-since/SynTexDZN/syntex-logger/1.0.0?color=yellow&label=commits&style=for-the-badge)](https://github.com/SynTexDZN/syntex-logger/commits)
[![GitHub Code Size](https://img.shields.io/github/languages/code-size/SynTexDZN/syntex-logger?color=0af&style=for-the-badge)](https://github.com/SynTexDZN/syntex-logger)

<br>

## Use This In Your Code
```js
let Logger = require('syntex-logger');

let logger = new Logger({ pluginName : 'Demo Plugin', language : 'us', config : { debug : false } });

logger.setLogDirectory('/var/demo_plugin/logs');

var level = 'success',
    categoryOne = 'first_category',
    categoryTwo = 'second_category',
    message = 'You got it! :D';

logger.log(level, categoryOne, categoryTwo, message);

logger.debug('Test');

try
{
    [ ... ]
}
catch(e)
{
    logger.err(e);
}
```
## Troubleshooting
#### [![GitHub Issues](https://img.shields.io/github/issues-raw/SynTexDZN/syntex-logger?logo=github&style=for-the-badge)](https://github.com/SynTexDZN/syntex-logger/issues)
- `Report` us your `Issues`
- `Join` our `Discord Server`
#### [![Discord](https://img.shields.io/discord/442095224953634828?color=5865F2&logoColor=white&label=discord&logo=discord&style=for-the-badge)](https://discord.gg/XUqghtw4DE)


---


## Logging Levels
- `error` ( *same level as `logger.err()`* )
- `warn`
- `info`
- `success`
- `read`
- `update`
- `debug` ( *default level when using `logger.debug()`* )

## Supported Languages
- `English` ( *us, en* )
- `German` ( *de* )
- `German & English` ( *deen* )

For language codes look at `/languages/` for current translated phrases.<br>
You can use them like this `%update_error%` in your message string.