file-error-logging/README.md

Log your errors directly to the console and to a .log file

# file-error-logging

A lightweight, flexible logging library for Node.js applications. This library provides an intuitive API for managing log levels, formatting logs, and writing logs to files. It includes a Singleton-based Logger class with out-of-the-box support for logging `info`, `warn`, `error`, and `verbose` levels. 

Future updates will introduce a **CLI** for easier configuration and use.

## Features

- **Default Log Levels**: `info`, `warn`, `error`, `verb` (verbose).
- **File-based Logging**: Logs are written to individual files for each log level.
- **Log Rotation**: Save logs on folders depending on the day, month or year.
- **Dynamic Configuration**: Add custom log levels with their own color, timestamping, and file logging rules.
- **Extensive Configuration**: Change the behavior of the logger by passing an options object.
- **Singleton Pattern**: Ensures a single instance of the logger throughout the application.

## Installation

To install the package, use npm:

```bash
npm install file-error-logging
```

## Usage

[See the Wiki for usage](https://asterki.github.io/file-error-logging/)

## Contributing

Contributions are welcome! Please submit a pull request or file an issue on the [GitHub repository](https://github.com/Asterki/file-error-logging).

## License

This project is licensed under the Apache-v2.0 License. See the [LICENSE](./LICENSE) file for details.

---

Happy Logging!